X (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 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 'X' character for its value. Using 'X' automatically creates a TQL statement for every Item ID associated with that Clause Parameter in the project data. These statements are processed as an array, returning a corresponding array of results.
Instead of specifying a clause parameter with a particular [[Item ID]], it is possible to use the 'X' character for its value. Using 'X' automatically creates a TQL statement for every Item ID associated with that Clause Parameter in the project data. These statements are processed as an array, returning a corresponding array of results.
==Clause Parameters==
The X value can be used in the following TQL Clause parameters:
<div style="column-count:3">
*[[Address (TQL Param)]]
*[[Area (TQL Param)]]
*[[Building (TQL Param)]]
*[[Category (TQL Param)]]
*[[Function (TQL Param)]]
*[[Global (TQL Param)]]
*[[Grid (TQL Param)]]
*[[Gridtype (TQL Param)]]
*[[Index (TQL Param)]]
*[[Indicator (TQL Param)]]
*[[Layertype (TQL Param)]]
*[[Levee (TQL Param)]]
*[[Map (TQL Param)]]
*[[Measure (TQL Param)]]
*[[Neighborhood (TQL Param)]]
*[[Net line (TQL Param)]]
*[[Net type (TQL Param)]]
*[[Net function (TQL Param)]]
*[[Net load (TQL Param)]]
*[[Net cluster (TQL Param)]]
*[[Overlay (TQL Param)]]
*[[Panel (TQL Param)]]
*[[Stakeholder (TQL Param)]]
*[[Terrain (TQL Param)]]
*[[Timeframe (TQL Param)]]
*[[Zone (TQL Param)]]
</div>


==Example==
==Example==
Line 15: Line 46:
The statement  
The statement  
<pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_X</pre> is expanded into the following comma-separated list:
<pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_X</pre> is expanded into the following comma-separated list:
<pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_2, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_3, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_4</pre>
<pre>[ SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_2, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_3, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_4 ]</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>[ "De Manege", "De Lancaster", "De Landstreken", "De Kruidentuin",  "Golfresidentie" ]</pre>
<pre>[ "De Manege", "De Lancaster", "De Landstreken", "De Kruidentuin",  "Golfresidentie" ]</pre>
==Clause Parameters==
The X value can be used in the following TQL Clause parameters:


{{article end
{{article end
|notes=*The result of an X-queries are array of values without the brackets when the [[Setting#TQL_PANEL_BRACKETED|Setting TQL_PANEL_BRACKETED]] is set to 'false'.
|seealso=
|seealso=
*[[Y (TQL)]]
*[[Y (TQL)]]
Line 30: Line 57:
*[[XK (TQL)]]
*[[XK (TQL)]]
*[[ID (TQL)]]
*[[ID (TQL)]]
|api=*[[Api session event editor building query]]
*[[Tag#TQL Tags with X and Y Queries|TQL Tags with X and Y Queries]]
|api=*[[Api session query]]
}}
}}


{{TQL param nav}}
{{TQL param nav}}

Latest revision as of 08:35, 12 November 2026

Instead of specifying a clause parameter with a particular Item ID, it is possible to use the 'X' character for its value. Using 'X' automatically creates a TQL statement for every Item ID associated with that Clause Parameter in the project data. These statements are processed as an array, returning a corresponding array of results.

Clause Parameters

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

Example

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

[ 
 { "id" : 0, "name" : "De Manege" },
 { "id" : 1, "name" : "De Lancaster" }, 
 { "id" : 2, "name" : "De Landstreken" }, 
 { "id" : 3, "name" : "De Kruidentuin" },
 { "id" : 4, "name" : "Golfresidentie" } 
]

The statement

SELECT_NAME_WHERE_NEIGHBORHOOD_IS_X

is expanded into the following comma-separated list:

[ SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_2, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_3, SELECT_NAME_WHERE_NEIGHBORHOOD_IS_4 ]

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

[ "De Manege", "De Lancaster", "De Landstreken", "De Kruidentuin",  "Golfresidentie" ]