XC (TQL): Difference between revisions
No edit summary |
|||
| Line 68: | Line 68: | ||
*[[XA (TQL)]] | *[[XA (TQL)]] | ||
*[[XK (TQL)]] | *[[XK (TQL)]] | ||
|api=*[[Api session | |api=*[[Api session query]] | ||
}} | }} | ||
{{TQL param nav}} | {{TQL param nav}} | ||
Revision as of 14:16, 3 November 2026
Instead of specifying a clause parameter with a particular Item ID, it is possible to use the 'XC' characters for its value. Using 'XC' automatically creates a TQL statement for every Item ID in that clause parameter that overlaps the Search Polygon. Both the generated TQL statements and their results are handled internally as arrays.
This Search Polygon is determined by the linked content item. Since content item linkage is currently limited to Template Text and Excel Panels, XC should only be used there.
Clause Parameters
The XC value can be used in the following TQL Clause parameters:
Example
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 ] ] ] ] }
} ]
For example, a TQL statement in a Template Text Panel applied to neighborhoods creates separate instances for 'East Side' and '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 commas,
[ SELECT_NAME_WHERE_AREA_IS_1, SELECT_NAME_WHERE_AREA_IS_3 ]
Its result will be a list of names, separated by commas; for example:
[ "Upper Right", "Lower Right" ]
Notes
- The following variants on XC exist:
- The result of an XC-queries are array of values without the brackets when the Setting TQL_PANEL_BRACKETED is set to 'false'.
See also
API Endpoints