ID (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
49,035 edits
Created page with "Instead of specifying the value of a clause parameter with a particular Item ID, it is possible to use the 'ID' characters for its value. The result of using 'ID' for the clause value, is that is automatically filled in using the Item that contains the TQL statement. ID clause values are often used in combination with Template Panels; For example: Consider A Template Text Panel applied on Neighborhoods ==Example== Consider the following (simplified) Neighborho..."
 
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
Instead of specifying the value of a clause parameter with a particular [[Item ID]], it is possible to use the 'ID' characters for its value. The result of using 'ID' for the clause value, is that is automatically filled in using the Item that contains the TQL statement.
Instead of a specific [[Item ID]], you can use 'ID' as a clause parameter value. This is automatically replaced by the ID of the Item containing the TQL statement.


ID clause values are often used in combination with [[Template Panel]]s; For example: Consider A Template Text Panel applied on Neighborhoods  
ID clause values are often used in combination with [[Template Panel]]s; For example: Consider A Template Text Panel applied on Neighborhoods  
==Clause Parameters==
The ID value can be used in the following TQL Clause parameters:
<div style="column-count:3">
*[[Address (TQL Param)]]
*[[Area (TQL Param)]]
*[[Building (TQL Param)]]
*[[Function (TQL Param)]]
*[[Global (TQL Param)]]
*[[Grid (TQL Param)]]
*[[Indicator (TQL Param)]]
*[[Levee (TQL Param)]]
*[[Measure (TQL Param)]]
*[[Neighborhood (TQL Param)]]
*[[Net line (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)]]
*[[Zone (TQL Param)]]
</div>


==Example==
==Example==
Line 7: Line 31:
<pre>
<pre>
[  
[  
  { "id" : 0, "name" : "East Side", "attributes": { "INHABITANTS": 600.0 } },
  { "id" : 0, "name" : "East Side", "attributes": { "INHABITANTS": [ 600.0 ] } },
  { "id" : 1, "name" : "West Side", "attributes": { "INHABITANTS": 200.0 } }
  { "id" : 1, "name" : "West Side", "attributes": { "INHABITANTS": [ 200.0 ] } }
]
]
</pre>
</pre>


And a Template Text Panel applied on Neighborhoods:
And a Template Text Panel applied on Neighborhoods, resulting in two Text Panel instances:
<pre>
<pre>
[
[  
{
{  
   "id" : 2,
   "id" : 2, "mapLink" : "NEIGHBORHOODS", "name" : "Template Text Panel",  "type" : "TEMPLATE_TEXT_PANEL",
  "mapLink" : "NEIGHBORHOODS",
   "text" : "Name: $SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID<br>Inhabitants: $SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS"
  "name" : "Template Text Panel",
  } , {  
   "text" : "Name: $SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID<br>Inhabitants: $SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS",
   "contentID" : 0, "contentMapLink" : "NEIGHBORHOODS", "id" : 3, "name" : "Template Text Panel: East Side",  "parentID" : 2, "type" : "TEXT_PANEL"  
  "type" : "TEMPLATE_TEXT_PANEL",  
} , {  
},
   "contentID" : 1, "contentMapLink" : "NEIGHBORHOODS", "id" : 4, "name" : "Template Text Panel: West Side", "parentID" : 2, "type" : "TEXT_PANEL"  
{
}  
   "contentID" : 0,
  "contentMapLink" : "NEIGHBORHOODS",
  "id" : 3,
  "name" : "Template Text Panel: East Side",  
   "parentID" : 2,
  "type" : "TEXT_PANEL",
},
{
   "contentID" : 1,
  "contentMapLink" : "NEIGHBORHOODS",
  "id" : 4,
  "name" : "Template Text Panel: West Side",  
  "parentID" : 2,
  "type" : "TEXT_PANEL",
}
]
]
</pre>
</pre>


The TQL statement  
Since each panel is linked to a particular Neighborhood, through the ''contentID'' and ''contentMapLink'' parameters, the TQL statement <code>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID</code> is internally replaced with:
<pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID</pre> is internally replaced with
:<code>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0</code> for the first Text Panel
<pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0/pre> for the first Text Panel and <pre>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1/pre> for the second Text Panel, as these are the Neighborhoods each panel is linked to (using the ''contentID'' and ''contentMaplink'' parameters).
:<code>SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1</code> for the second Text Panel
 
The result of each query will be:
The result of each query will be:
<pre>"East Side"</pre> and <pre>"West Side"</pre>
<code>"East Side"</code> and <code>"West Side"</code>
 
Similarly, the value of the attribute INHABITANTS of the linked Neighborhood can be obtained using  
Similarly, the value of the attribute INHABITANTS of the linked Neighborhood can be obtained using  
<pre>SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS</pre>.
<code>SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS</code>.
 


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


{{article end
{{article end
Line 56: Line 66:
|seealso=
|seealso=
*[[Y (TQL)]]
*[[Y (TQL)]]
*[[XA (TQL)]]
*[[X (TQL)]]
*[[XC (TQL)]]
*[[Item ID]]
*[[XK (TQL)]]
|api=*[[Api session query]]
 
}}
}}


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

Latest revision as of 14:15, 3 November 2026

Instead of a specific Item ID, you can use 'ID' as a clause parameter value. This is automatically replaced by the ID of the Item containing the TQL statement.

ID clause values are often used in combination with Template Panels; For example: Consider A Template Text Panel applied on Neighborhoods

Clause Parameters

The ID 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", "attributes": { "INHABITANTS": [ 600.0 ] } },
 { "id" : 1, "name" : "West Side", "attributes": { "INHABITANTS": [ 200.0 ] } }
]

And a Template Text Panel applied on Neighborhoods, resulting in two Text Panel instances: 

[ 
 { 
  "id" : 2, "mapLink" : "NEIGHBORHOODS", "name" : "Template Text Panel",  "type" : "TEMPLATE_TEXT_PANEL",
  "text" : "Name: $SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID<br>Inhabitants: $SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS"  
 } , { 
  "contentID" : 0, "contentMapLink" : "NEIGHBORHOODS",  "id" : 3,  "name" : "Template Text Panel: East Side",   "parentID" : 2,  "type" : "TEXT_PANEL" 
 } , { 
  "contentID" : 1, "contentMapLink" : "NEIGHBORHOODS", "id" : 4, "name" : "Template Text Panel: West Side", "parentID" : 2, "type" : "TEXT_PANEL" 
 } 
]

Since each panel is linked to a particular Neighborhood, through the contentID and contentMapLink parameters, the TQL statement SELECT_NAME_WHERE_NEIGHBORHOOD_IS_ID is internally replaced with:

SELECT_NAME_WHERE_NEIGHBORHOOD_IS_0 for the first Text Panel
SELECT_NAME_WHERE_NEIGHBORHOOD_IS_1 for the second Text Panel

The result of each query will be: "East Side" and "West Side"

Similarly, the value of the attribute INHABITANTS of the linked Neighborhood can be obtained using SELECT_ATTRIBUTE_WHERE_NEIGHBORHOOD_IS_ID_AND_NAME_IS_INHABITANTS.


See also

API Endpoints

TQL Clause parameters
Spatial
Area • Area with attribute • Buffer • Layertype • Map • Neighborhood • Neighborhood with attribute • Terrain • Terrain with attribute • Zone • Zone with attribute
Attribute
Attribute • Attribute max • Attribute min • Attribute mult • Index
Grid
Grid • Grid with attribute • Gridtype • Gridvalue • Maxgridvalue • Mingridvalue • Overlay • Resulttype • Timeframe
Item
Address • Building • Building with attribute • Function • Global • Indicator • Levee • Measure • Panel • Relation • Scenario • Stakeholder
Net
Net line • Net type • Net function • Net load • Net cluster
Property
Category • Categorymult • Crs • Functionmult • Layertype • Iteration • Key • Map • Name • Residence • Road system • Stakeholdertype • State • Term
Replacement
X • XA • XC • XK • Y • YA • YC • YK • ID • Relation • Sort
Other
Select • Update


Retrieved from "https://support.tygron.com/w/index.php?title=ID_(TQL)&oldid=96247"