XC (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
Instead of specifying a clause parameter with a particular [[Item ID]], it is possible to use the 'XC' characters for its value. The result of using 'XC' for the clause value, is the automatic creation of multiple TQL statements, one with each Item ID for that Clause Parameter, but only the Items that are covered by the calculated ''Search Polygon'' of the TQL statement. The ''Search Polygon'' is calculated by overlapping the clause polygon. Per clause type it is indicated if it limits the 'Search Polygon'. Internally, the resulting TQL statements are placed in a single array; Similarly the result will be an array of TQL results.
Instead of specifying a clause parameter with a particular [[Item ID]], it is possible to use the 'XC' characters for its value. The result of using 'XC' for the clause value, is the automatic creation of multiple TQL statements, one with each Item ID for that Clause Parameter, but only the Items that are covered by the ''Search Polygon'' of the TQL statement. Items are only included if they are overlapped by the ''Search Polygon''. Internally, the resulting TQL statements are placed in a single array; Similarly the result will be an array of TQL results.
 
This ''Search Polygon'' is determined by the linked content item. Currently content item linkage only occurs with Template Text and Excel Panels and therefore XC should only be used for this Panels.  


==Example==
==Example==
Line 30: Line 32:
</pre>
</pre>


The TQL statement  
Also Consider the situation where a TQL statement is present in the Text Body of a Template Text Panel. This Template Panel is applied on neighborhoods, creating two Text Panel instances, one automatically linked to Neighborhood 'East Side' and one to 'West Side.
<pre>SELECT_NAME_WHERE_AREA_IS_XC_AND_NEIGHBORHOOD_IS_0</pre> is internally replaced with a list of TQL statements, separated by comma's,
 
<pre>SELECT_NAME_WHERE_AREA_IS_1_AND_NEIGHBORHOOD_IS_0, SELECT_NAME_WHERE_AREA_IS_3_AND_NEIGHBORHOOD_IS_0</pre>
The TQL statement
<pre>SELECT_NAME_WHERE_AREA_IS_XC</pre>
for the Text Panel linked to Neighborhood "East Side" is internally replaced with a list of TQL statements, separated by comma's,
<pre>SELECT_NAME_WHERE_AREA_IS_1, SELECT_NAME_WHERE_AREA_IS_3</pre>
Its result will be a list of names, separated by comma's, for example:
Its result will be a list of names, separated by comma's, for example:
<pre>"Upper Right", "Lower Right"</pre>
<pre>"Upper Right", "Lower Right"</pre>
Line 46: Line 51:
*[[Net load (TQL Param)]]
*[[Net load (TQL Param)]]
*[[Net line (TQL Param)]]
*[[Net line (TQL Param)]]
</div>


{{article end
{{article end

Latest revision as of 15:00, 20 May 2026

Instead of specifying a clause parameter with a particular Item ID, it is possible to use the 'XC' characters for its value. The result of using 'XC' for the clause value, is the automatic creation of multiple TQL statements, one with each Item ID for that Clause Parameter, but only the Items that are covered by the Search Polygon of the TQL statement. Items are only included if they are overlapped by the Search Polygon. Internally, the resulting TQL statements are placed in a single array; Similarly the result will be an array of TQL results.

This Search Polygon is determined by the linked content item. Currently content item linkage only occurs with Template Text and Excel Panels and therefore XC should only be used for this Panels.

Example

Neighborhoods in an example project
Areas in an example project

Consider the following (simplified) Neighborhood data of a project:

[ {
  "id" : 0,  "name" : "East Side",
  "polygons" : { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 250.0, -500.0 ], [ 500.0, -500.0 ], [ 500.0, 0.0 ], [ 250.0, 0.0 ], [ 250.0, -500.0 ] ] ] ]  }
}, {
  "id" : 1,  "name" : "West Side",
  "polygons" : {  "type" : "MultiPolygon", "coordinates" : [ [ [ [ 0.0, -500.0 ], [ 250.0, -500.0 ], [ 250.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, -500.0 ] ] ] ]  }
} ]

and the Area data:

[ {
  "id" : 0,  "name" : "Upper Left",  
  "polygons" : {    "type" : "MultiPolygon",    "coordinates" : [ [ [ [ 110.0, -110.0 ], [ 110.0, -100.0 ], [ 100.0, -100.0 ], [ 100.0, -110.0 ], [ 110.0, -110.0 ] ] ] ]  }
  }, {
  "id" : 1,  "name" : "Upper Right",  
  "polygons" : {    "type" : "MultiPolygon",    "coordinates" : [ [ [ [ 435.0, -95.0 ], [ 425.0, -95.0 ], [ 425.0, -105.0 ], [ 435.0, -105.0 ], [ 435.0, -95.0 ] ] ] ]  }
  }, {  
  "id" : 2,  "name" : "Lower Left",  
  "polygons" : {    "type" : "MultiPolygon",    "coordinates" : [ [ [ [ 165.0, -425.0 ], [ 165.0, -415.0 ], [ 155.0, -415.0 ], [ 155.0, -425.0 ], [ 165.0, -425.0 ] ] ] ]  }
  }, {  
  "id" : 3,  "name" : "Lower Right",  
  "polygons" : {    "type" : "MultiPolygon",    "coordinates" : [ [ [ [ 315.0, -395.0 ], [ 325.0, -395.0 ], [ 325.0, -385.0 ], [ 315.0, -385.0 ], [ 315.0, -395.0 ] ] ] ]  }
} ]

Also Consider the situation where a TQL statement is present in the Text Body of a Template Text Panel. This Template Panel is applied on neighborhoods, creating two Text Panel instances, one automatically linked to Neighborhood 'East Side' and one to 'West Side.

The TQL statement

SELECT_NAME_WHERE_AREA_IS_XC

for the Text Panel linked to Neighborhood "East Side" is internally replaced with a list of TQL statements, separated by comma's,

SELECT_NAME_WHERE_AREA_IS_1, SELECT_NAME_WHERE_AREA_IS_3

Its result will be a list of names, separated by comma's, for example:

"Upper Right", "Lower Right"

Clause Parameters

The XC value can be used in the following TQL Clause parameters:

Notes

  • The following variants on XC exist:
    • XCA: A combination between XC and XA.
    • XCK: A combination between XC and XK.

See also