Api session items overlays: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 25: Line 25:
   "sortIndex" : 52,
   "sortIndex" : 52,
   "type" : null,
   "type" : null,
   "version" : 121,
   "version" : 1,
   "visible" : true
   "visible" : true
}, {
}, {
Line 86: Line 86:
   "sortIndex" : 51,
   "sortIndex" : 51,
   "type" : "NEIGHBORHOODS",
   "type" : "NEIGHBORHOODS",
   "version" : 118,
   "version" : 12,
   "visible" : true
   "visible" : true
} ]</syntaxhighlight>
} ]</syntaxhighlight>
Line 114: Line 114:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model ActionLog==
==Api Model AeriusOverlay==
API Model description of ActionLog
API Model description of AeriusOverlay


{|class=wikitable
{|class=wikitable
Line 122: Line 122:
!Description
!Description
|-
|-
|action
|attributes
|ParticipantEventType
|Map&lt;String,double[]&gt;
|
|
|-
|-
|budget
|colorMultiplier
|double
|double
|
|
|-
|-
|buildingIDs
|colorOffset
|int<nowiki>[]</nowiki>
|int
|
|
|-
|-
|id
|customLegend
|int
|boolean
|
|
|-
|-
|itemID
|id
|int
|int
|
|
|-
|-
|mapLink
|imageName
|MapLink
|String
|
|
|-
|-
|mp
|imageVersion
|MultiPolygon
|int
|
|
|-
|-
|point
|legend
|Point
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|scoreAfter
|maquetteOverride
|Map&lt;int,double&gt;
|Map&lt;String,double[]&gt;
|
|
|-
|-
|scoreBefore
|name
|Map&lt;int,double&gt;
|String
|
|
|-
|-
|simTime
|parentID
|long
|int
|
|[[Overlay]] ID
|-
|-
|stakeholderID
|sortIndex
|int
|int
|[[Stakeholder]] ID
|
|-
|-
|subject
|type
|String
|OverlayType
|
|
|-
|-
|version
|version
|int
|int
|
|-
|visible
|boolean
|
|
|}
|}


==Api Model ActionMenu==
==Api Model AreaOverlay==
API Model description of ActionMenu
API Model description of AreaOverlay


{|class=wikitable
{|class=wikitable
Line 187: Line 191:
!Description
!Description
|-
|-
|attributeActionIDs
|areaIDs
|int<nowiki>[]</nowiki>
|int<nowiki>[]</nowiki>
|[[Attribute Action]] ID  
|[[Area]] ID  
|-
|-
|buildable
|attributes
|Map&lt;int,java.util.List<java.lang.Integer>&gt;
|Map&lt;String,double[]&gt;
|
|
|-
|-
|color
|colorMultiplier
|TColor
|double
|
|
|-
|-
|eventBundleIDs
|colorOffset
|int<nowiki>[]</nowiki>
|int
|[[Event Bundle]] ID
|
|-
|-
|functionIDs
|customLegend
|int<nowiki>[]</nowiki>
|boolean
|[[Function]] ID
|
|-
|-
|id
|id
Line 219: Line 223:
|
|
|-
|-
|leveeIDs
|legend
|int<nowiki>[]</nowiki>
|LegendEntry<nowiki>[]</nowiki>
|[[Levee]] ID
|
|-
|-
|measureIDs
|maquetteOverride
|int<nowiki>[]</nowiki>
|Map&lt;String,double[]&gt;
|[[Measure]] ID
|
|-
|-
|name
|name
|String
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|remainderColor
|TColor
|
|
|-
|-
Line 235: Line 247:
|
|
|-
|-
|specialOptions
|type
|Type<nowiki>[]</nowiki>
|OverlayType
|
|
|-
|upgradeIDs
|int<nowiki>[]</nowiki>
|[[Upgrade Type]] ID
|-
|-
|version
|version
|int
|int
|
|}
==Api Model ActionType==
API Enumeration description of ActionType
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION_PLAN
|
|
|-
|-
|CONSTRUCTION_PLAN_CANCEL
|visible
|boolean
|
|
|}
|}


==Api Model Addition==
==Api Model AttributeOverlay==
API Model description of Addition
API Model description of AttributeOverlay


{|class=wikitable
{|class=wikitable
Line 270: Line 268:
!Description
!Description
|-
|-
|amount
|attribute
|int
|String
|
|-
|attributeColor
|TColor
|
|
|-
|-
|animMultiplier
|attributes
|double
|Map&lt;String,double[]&gt;
|
|
|-
|-
|name
|colorAttribute
|String
|String
|
|
|-
|-
|randomScale
|colorMultiplier
|double
|double
|
|
|-
|-
|show
|colorOffset
|Show
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|
|}
==Api Model Address==
API Model description of Address
{|class=wikitable
!Name
!Type
!Description
|-
|-
|addition
|imageName
|String
|String
|
|
|-
|-
|attributes
|imageVersion
|Map&lt;String,double[]&gt;
|int
|
|
|-
|-
|id
|legend
|int
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|letter
|mapLink
|String
|MapLink
|
|
|-
|-
Line 323: Line 324:
|
|
|-
|-
|number
|parentID
|int
|int
|
|[[Overlay]] ID
|-
|-
|point
|restColor
|Point
|TColor
|
|
|-
|-
|sourceIDs
|sortIndex
|int<nowiki>[]</nowiki>
|int
|[[Source]] ID
|-
|street
|String
|
|-
|surfaceSize
|double
|
|
|-
|-
|type
|type
|String
|OverlayType
|
|
|-
|-
Line 351: Line 344:
|
|
|-
|-
|zipCode
|visible
|String
|boolean
|
|
|}
|}


==Api Model AddressAttribute==
==Api Model AvgOverlay==
API Enumeration description of AddressAttribute
API Model description of AvgOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ENERGY_LABEL
|active
|boolean
|
|
|-
|-
|CADASTRAL_PURPOSE
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|RESIDENCE_TYPE
|calcTimeMS
|long
|
|
|-
|-
|INHABITANTS
|colorMultiplier
|double
|
|
|-
|-
|FLOOR_SPACE_M2
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|}
==Api Model AeriusOverlay==
API Model description of AeriusOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attributes
|id
|Map&lt;String,double[]&gt;
|int
|
|
|-
|-
|colorMultiplier
|imageName
|double
|String
|
|
|-
|-
|colorOffset
|imageVersion
|int
|int
|
|
|-
|-
|customLegend
|inActiveCellSize
|boolean
|double
|
|
|-
|-
|id
|inActiveTimeframes
|int
|int
|
|
|-
|-
|imageName
|keys
|String
|Map&lt;String,String&gt;
|
|
|-
|-
|imageVersion
|layerMapLink
|int
|MapLink
|
|
|-
|-
Line 421: Line 419:
|maquetteOverride
|maquetteOverride
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|
|-
|-
Line 431: Line 437:
|[[Overlay]] ID  
|[[Overlay]] ID  
|-
|-
|sortIndex
|prequels
|int
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|type
|rasterization
|OverlayType
|Rasterization
|
|
|-
|-
|version
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|int
|
|
Line 445: Line 467:
|visible
|visible
|boolean
|boolean
|
|}
==Api Model Alignment==
API Enumeration description of Alignment
{|class=wikitable
!Name
!Description
|-
|ROAD
|
|
|-
|-
|SPACED
|warnings
|String
|
|
|}
|}


==Api Model Answer==
==Api Model ComboOverlay==
API Model description of Answer
API Model description of ComboOverlay


{|class=wikitable
{|class=wikitable
Line 470: Line 482:
!Description
!Description
|-
|-
|clientEvents
|active
|CodedEvent<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|contents
|attributes
|String
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|
|-
|-
|events
|colorMultiplier
|CodedEvent<nowiki>[]</nowiki>
|double
|
|
|-
|-
|id
|colorOffset
|int
|int
|
|
|-
|-
|selected
|customLegend
|boolean
|boolean
|
|
|}
==Api Model Area==
API Model description of Area
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attributes
|diffLegend
|Map&lt;String,double[]&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|center
|formula
|Point
|String
|
|
|-
|-
Line 511: Line 518:
|
|
|-
|-
|maquetteOverride
|imageName
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|String
|
|
|-
|-
|polygons
|imageVersion
|MultiPolygon
|int
|
|
|-
|-
|relations
|inActiveCellSize
|Map&lt;Relation,int&gt;
|double
|
|
|-
|-
|sourceIDs
|inActiveTimeframes
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|int
|
|
|}
==Api Model AreaAttribute==
API Enumeration description of AreaAttribute
{|class=wikitable
!Name
!Description
|-
|-
|ACTIVE
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|NATURE_RESERVE
|layerMapLink
|MapLink
|
|
|-
|-
|INTEREST_AREA
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|}
==Api Model AreaOverlay==
API Model description of AreaOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|areaIDs
|maquetteOverride
|int<nowiki>[]</nowiki>
|[[Area]] ID
|-
|attributes
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|
|-
|-
|colorMultiplier
|maxValue
|double
|float[]
|
|
|-
|-
|colorOffset
|minValue
|int
|float[]
|
|
|-
|-
|customLegend
|name
|boolean
|String
|
|
|-
|-
|id
|parentID
|int
|int
|
|[[Overlay]] ID
|-
|-
|imageName
|prequels
|String
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|imageVersion
|rasterization
|int
|Rasterization
|
|
|-
|-
|legend
|resultType
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|String
|
|
|-
|-
|parentID
|showDifference
|int
|boolean
|[[Overlay]] ID
|-
|remainderColor
|TColor
|
|
|-
|-
Line 627: Line 596:
|visible
|visible
|boolean
|boolean
|
|-
|warnings
|String
|
|
|}
|}


==Api Model AssetValue==
==Api Model DefaultOverlay==
API Enumeration description of AssetValue
API Model description of DefaultOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|NAME
|active
|boolean
|
|
|-
|-
|DESCRIPTION
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|ID
|calcTimeMS
|long
|
|
|-
|-
|IMAGELOCATION
|colorMultiplier
|double
|
|
|-
|-
|ROOF_COLOR
|colorOffset
|int
|
|
|-
|-
|BASEMENT_COLOR
|customLegend
|boolean
|
|
|-
|-
|GROUND_COLOR
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|EXTRA_COLOR
|id
|int
|
|
|-
|-
|TOP_COLOR
|imageName
|String
|
|-
|imageVersion
|int
|
|
|}
==Api Model AttributeItem==
API Model description of AttributeItem
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attributes
|inActiveCellSize
|Map&lt;String,double[]&gt;
|double
|
|
|-
|-
|id
|inActiveTimeframes
|int
|int
|
|
|-
|-
|maquetteOverride
|keys
|Map&lt;String,double[]&gt;
|Map&lt;String,String&gt;
|
|
|-
|-
|name
|legend
|String
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|version
|maquetteOverride
|int
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model AttributeKey==
API Enumeration description of AttributeKey
{|class=wikitable
!Name
!Description
|-
|-
|A
|maxValue
|float[]
|
|
|-
|-
|B
|minValue
|float[]
|
|
|-
|-
|C
|name
|String
|
|
|-
|-
|D
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|E
|resultType
|String
|
|
|-
|-
|F
|showDifference
|boolean
|
|
|-
|-
|G
|sortIndex
|int
|
|
|-
|-
|H
|type
|OverlayType
|
|
|-
|-
|I
|version
|int
|
|
|-
|-
|J
|visible
|boolean
|
|-
|warnings
|String
|
|
|}
|}


==Api Model AttributeOverlay==
==Api Model DefaultRasterizationOverlay==
API Model description of AttributeOverlay
API Model description of DefaultRasterizationOverlay


{|class=wikitable
{|class=wikitable
Line 740: Line 728:
!Description
!Description
|-
|-
|attribute
|active
|String
|boolean
|
|-
|attributeColor
|TColor
|
|
|-
|-
Line 752: Line 736:
|
|
|-
|-
|colorAttribute
|calcTimeMS
|String
|long
|
|
|-
|-
Line 766: Line 750:
|customLegend
|customLegend
|boolean
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
Line 780: Line 768:
|
|
|-
|-
|legend
|inActiveCellSize
|LegendEntry<nowiki>[]</nowiki>
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|mapLink
|layerMapLink
|MapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|maquetteOverride
|maquetteOverride
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|
|-
|-
Line 800: Line 808:
|[[Overlay]] ID  
|[[Overlay]] ID  
|-
|-
|restColor
|prequels
|TColor
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|
|-
|-
Line 819: Line 839:
|boolean
|boolean
|
|
|}
==Api Model AttributeOverlayPredicate==
API Model description of AttributeOverlayPredicate
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attribute
|warnings
|String
|String
|
|-
|mapLink
|MapLink
|
|
|}
|}


==Api Model AvgModelAttribute==
==Api Model DischargeMethod==
API Enumeration description of AvgModelAttribute
API Enumeration description of DischargeMethod


{|class=wikitable
{|class=wikitable
Line 845: Line 852:
!Description
!Description
|-
|-
|DISTANCE_M
|HEIGHT_MINIMA
|
|
|-
|-
|ATTRIBUTE_TIMEFRAMES
|WATER_TERRAINS
|
|
|-
|-
|DEFAULT_VALUE
|AREAS
|
|-
|SURFACE_ONLY
|
|
|}
|}


==Api Model AvgOverlay==
==Api Model DistanceOverlay==
API Model description of AvgOverlay
API Model description of DistanceOverlay


{|class=wikitable
{|class=wikitable
Line 983: Line 987:
|}
|}


==Api Model BGTFunctionLink==
==Api Model FloodingOverlay==
API Model description of BGTFunctionLink
API Model description of FloodingOverlay


{|class=wikitable
{|class=wikitable
Line 991: Line 995:
!Description
!Description
|-
|-
|categories
|active
|Category<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|className
|attributes
|String
|Map&lt;String,double[]&gt;
|
|
|-
|-
|functionID
|calcInfo
|int
|String
|[[Function]] ID
|-
|id
|int
|
|
|-
|-
|layer
|calcTimeMS
|BGTLayer
|long
|
|
|-
|-
|priority
|colorMultiplier
|int
|double
|
|
|-
|-
|transmissionTowerFoundations
|colorOffset
|int
|int
|
|
|-
|-
|tree
|customLegend
|boolean
|boolean
|
|
|-
|-
|typeName
|diffLegend
|String
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|version
|id
|int
|int
|
|
|}
==Api Model BGTLayer==
API Enumeration description of BGTLayer
{|class=wikitable
!Name
!Description
|-
|-
|BAK
|imageName
|String
|
|
|-
|-
|BEGROEIDTERREINDEEL
|imageVersion
|int
|
|
|-
|-
|BORD
|inActiveCellSize
|double
|
|
|-
|-
|BUURT
|inActiveTimeframes
|int
|
|
|-
|-
|FUNCTIONEELGEBIED
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|GEBOUWINSTALLATIE
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|INSTALLATIE
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|KAST
|maxValue
|float[]
|
|
|-
|-
|KUNSTWERKDEEL
|minValue
|float[]
|
|
|-
|-
|MAST
|mode
|Mode
|
|
|-
|-
|ONBEGROEIDTERREINDEEL
|name
|String
|
|
|-
|-
|ONDERSTEUNENDWATERDEEL
|parentID
|
|int
|[[Overlay]] ID
|-
|-
|ONDERSTEUNENDWEGDEEL
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|ONGECLASSIFICEERDOBJECT
|resultType
|String
|
|
|-
|-
|OPENBARERUIMTE
|showAreas
|boolean
|
|
|-
|-
|OPENBARERUIMTELABEL
|showDifference
|boolean
|
|
|-
|-
|OVERBRUGGINGSDEEL
|showSystem
|boolean
|
|
|-
|-
|OVERIGBOUWWERK
|sortIndex
|int
|
|
|-
|-
|OVERIGESCHEIDING
|type
|OverlayType
|
|
|-
|-
|PAAL
|version
|int
|
|
|-
|-
|PUBLIC
|visible
|boolean
|
|
|-
|-
|PAND
|warnings
|String
|
|
|-
|-
|PLAATSBEPALINGSPUNT
|weatherID
|
|int
|[[Weather]] ID
|}
 
==Api Model FunctionOverlay==
API Model description of FunctionOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|PUT
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|SCHEIDING
|colorMultiplier
|double
|
|
|-
|-
|SENSOR
|colorOffset
|int
|
|
|-
|-
|SPOOR
|customLegend
|boolean
|
|
|-
|-
|STRAATMEUBILAIR
|functionIDs
|
|int<nowiki>[]</nowiki>
|[[Function]] ID
|-
|-
|TUNNELDEEL
|functionsColor
|TColor
|
|
|-
|-
|VEGETATIEOBJECT
|id
|int
|
|
|-
|-
|WATERDEEL
|imageName
|String
|
|
|-
|-
|WATERINRICHTINGSELEMENT
|imageVersion
|int
|
|
|-
|-
|WEGDEEL
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|WEGINRICHTINGSELEMENT
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|WIJK
|name
|
|}
 
==Api Model BGTTerrainLink==
API Model description of BGTTerrainLink
 
{|class=wikitable
!Name
!Type
!Description
|-
|className
|String
|String
|
|
|-
|-
|id
|parentID
|int
|int
|
|[[Overlay]] ID
|-
|-
|layer
|remainderColor
|BGTLayer
|TColor
|
|
|-
|-
|priority
|sortIndex
|int
|int
|
|
|-
|-
|terrainTypeID
|type
|int
|OverlayType
|[[Terrain Type]] ID
|-
|typeName
|String
|
|
|-
|-
Line 1,180: Line 1,199:
|int
|int
|
|
|}
==Api Model BaseAttribute==
API Enumeration description of BaseAttribute
{|class=wikitable
!Name
!Description
|-
|-
|COLOR
|visible
|boolean
|
|
|}
|}


==Api Model BaseFunction==
==Api Model GeoTiffOverlay==
API Model description of BaseFunction
API Model description of GeoTiffOverlay


{|class=wikitable
{|class=wikitable
Line 1,200: Line 1,212:
!Type
!Type
!Description
!Description
|-
|active
|boolean
|
|-
|-
|attributes
|attributes
Line 1,205: Line 1,221:
|
|
|-
|-
|categories
|calcTimeMS
|Category<nowiki>[]</nowiki>
|long
|
|
|-
|-
|constructionPeriods
|colorMultiplier
|ConstructionPeriod<nowiki>[]</nowiki>
|double
|
|
|-
|-
|decals
|colorOffset
|Map&lt;FaceType,float[]&gt;
|int
|
|
|-
|-
|defaults
|customLegend
|Type<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|description
|diffLegend
|String
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|dimension
|geoTiffIDs
|int
|int<nowiki>[]</nowiki>
|
|[[GeoTIFF]] ID
|-
|-
|id
|id
Line 1,237: Line 1,253:
|
|
|-
|-
|modelSetID
|imageVersion
|int
|int
|[[Model Set]] ID
|
|-
|-
|name
|inActiveCellSize
|String
|double
|
|
|-
|-
|placementType
|inActiveTimeframes
|PlacementType
|int
|
|
|-
|-
|regions
|keys
|Region<nowiki>[]</nowiki>
|Map&lt;String,String&gt;
|
|
|-
|-
|textures
|legend
|Map&lt;FaceType,String&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|version
|maquetteOverride
|int
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|
|}
==Api Model BridgeElevation==
API Enumeration description of BridgeElevation
{|class=wikitable
!Name
!Description
|-
|-
|LOWEST
|version
|int
|
|
|-
|-
|TERRAIN
|visible
|boolean
|
|
|-
|-
|BRIDGE
|warnings
|String
|
|
|}
|}


==Api Model Building==
==Api Model GridOverlay==
API Model description of Building
API Model description of GridOverlay


{|class=wikitable
{|class=wikitable
Line 1,287: Line 1,334:
!Description
!Description
|-
|-
|addressIDs
|active
|int<nowiki>[]</nowiki>
|boolean
|[[Address]] ID
|
|-
|-
|attributes
|attributes
Line 1,295: Line 1,342:
|
|
|-
|-
|center
|calcTimeMS
|Point
|long
|
|
|-
|-
|customGeometries
|colorMultiplier
|CGLink<nowiki>[]</nowiki>
|double
|
|
|-
|-
|demolisherID
|colorOffset
|int
|int
|[[Stakeholder]] ID
|
|-
|-
|functionID
|customLegend
|int
|boolean
|[[Function]] ID
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|-
|id
|id
Line 1,315: Line 1,366:
|
|
|-
|-
|maquetteOverride
|imageName
|Map&lt;String,double[]&gt;
|String
|
|
|-
|-
|measureID
|imageVersion
|int
|int
|[[Measure]] ID
|
|-
|inActiveCellSize
|double
|
|-
|-
|modelVersion
|inActiveTimeframes
|int
|int
|
|
|-
|-
|name
|keys
|String
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|overrideCategories
|maquetteOverride
|Category<nowiki>[]</nowiki>
|Map&lt;String,double[]&gt;
|
|
|-
|-
|overrideDecals
|maxValue
|Map&lt;FaceType,float[]&gt;
|float[]
|
|
|-
|-
|ownerID
|minValue
|int
|float[]
|[[Stakeholder]] ID
|
|-
|-
|permitReceived
|name
|Map&lt;int,Boolean&gt;
|String
|
|
|-
|-
|predecessorID
|parentID
|int
|int
|[[Building]] ID  
|[[Overlay]] ID  
|-
|-
|sections
|prequels
|Section<nowiki>[]</nowiki>
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|sourceIDs
|resultType
|int<nowiki>[]</nowiki>
|String
|[[Source]] ID
|
|-
|-
|state
|showDifference
|TimeState
|boolean
|
|
|-
|-
|upgradeID
|sortIndex
|int
|int
|[[Upgrade Type]] ID
|
|-
|-
|upgradeOwnerID
|type
|int
|OverlayType
|[[Stakeholder]] ID
|
|-
|-
|version
|version
|int
|int
|
|
|}
|-
 
|visible
==Api Model BuildingAttribute==
|boolean
API Enumeration description of BuildingAttribute
 
{|class=wikitable
!Name
!Description
|-
|CONSTRUCTION_FINISH_DATE
|
|
|-
|-
|POWER_LINE_BUILDING_ID
|warnings
|
|String
|-
|MODEL_ANGLE
|
|-
|POPULATION_DENSITY_M2
|
|-
|GEOMETRY_COLOR
|
|-
|VACANT
|
|-
|PRIVATE_YARD
|
|
|}
|}


==Api Model CGLink==
==Api Model GroundwaterOverlay==
API Model description of CGLink
API Model description of GroundwaterOverlay


{|class=wikitable
{|class=wikitable
Line 1,413: Line 1,451:
!Description
!Description
|-
|-
|geometryID
|active
|int
|[[Custom Geometry]] ID
|-
|primary
|boolean
|boolean
|
|
|}
==Api Model Category==
API Enumeration description of Category
{|class=wikitable
!Name
!Description
|-
|-
|SOCIAL
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|NORMAL
|calcInfo
|String
|
|
|-
|-
|LUXE
|calcTimeMS
|long
|
|
|-
|-
|ROAD
|colorMultiplier
|double
|
|
|-
|-
|PAVED_AREA
|colorOffset
|int
|
|
|-
|-
|EDUCATION
|customLegend
|boolean
|
|
|-
|-
|HEALTHCARE
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|PARK
|id
|int
|
|
|-
|-
|NATURE
|imageName
|String
|
|
|-
|-
|INDUSTRY
|imageVersion
|int
|
|
|-
|-
|OFFICES
|inActiveCellSize
|double
|
|
|-
|-
|OTHER
|inActiveTimeframes
|int
|
|
|-
|-
|SENIOR
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|UNDERGROUND
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|SHOPPING
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|AGRICULTURE
|maxValue
|float[]
|
|
|-
|-
|LEISURE
|minValue
|float[]
|
|
|-
|-
|STUDENT
|mode
|Mode
|
|
|-
|-
|GARDEN
|name
|String
|
|
|-
|-
|INTERSECTION
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|BRIDGE
|resultType
|String
|
|
|}
==Api Model CategoryZone==
API Model description of CategoryZone
{|class=wikitable
!Name
!Type
!Description
|-
|-
|allowedCategories
|showAreas
|Category<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|attributes
|showDifference
|Map&lt;String,double[]&gt;
|boolean
|
|
|-
|-
|center
|showSystem
|Point
|boolean
|
|
|-
|-
|excelID
|sortIndex
|int
|int
|[[Excel Sheet]] ID
|
|-
|-
|excelUpdated
|type
|boolean
|OverlayType
|
|
|-
|-
|id
|version
|int
|int
|
|
|-
|-
|maquetteOverride
|visible
|Map&lt;String,double[]&gt;
|boolean
|
|
|-
|-
|name
|warnings
|String
|String
|
|
|-
|-
|outline
|weatherID
|Outline
|
|-
|parentZoneID
|int
|int
|[[Zone]] ID  
|[[Weather]] ID  
|-
|}
|permitterID
 
|int
==Api Model HeatModel==
|[[Stakeholder]] ID
API Enumeration description of HeatModel
 
{|class=wikitable
!Name
!Description
|-
|-
|polygons
|UNESCO
|MultiPolygon
|
|
|-
|-
|sourceIDs
|DPRA
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|
|}
|}


==Api Model ClimateModel==
==Api Model HeatOverlay==
API Model description of ClimateModel
API Model description of HeatOverlay


{|class=wikitable
{|class=wikitable
Line 1,566: Line 1,602:
!Description
!Description
|-
|-
|endTemp
|active
|double
|boolean
|
|
|-
|-
|endYear
|attributes
|int
|Map&lt;String,double[]&gt;
|
|
|-
|-
|oxidation
|calcInfo
|double
|String
|
|
|-
|-
|soilTempFactor
|calcTimeMS
|double
|long
|
|
|-
|-
|startTemp
|colorMultiplier
|double
|double
|
|
|-
|-
|startYear
|colorOffset
|int
|int
|
|
|}
|-
 
|customLegend
==Api Model CodedEvent==
|boolean
API Model description of CodedEvent
|
 
|-
{|class=wikitable
|diffLegend
!Name
|LegendEntry<nowiki>[]</nowiki>
!Type
|
!Description
|-
|-
|id
|id
Line 1,603: Line 1,638:
|
|
|-
|-
|parameters
|imageName
|Object<nowiki>[]</nowiki>
|String
|
|
|}
==Api Model ComboModelAttribute==
API Enumeration description of ComboModelAttribute
{|class=wikitable
!Name
!Description
|-
|-
|ATTRIBUTE_DEFAULT_VALUE
|imageVersion
|int
|
|
|-
|-
|ATTRIBUTE_SURFACE_ONLY
|inActiveCellSize
|double
|
|
|}
==Api Model ComboOverlay==
API Model description of ComboOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
|inActiveTimeframes
|boolean
|int
|
|
|-
|-
|attributes
|keys
|Map&lt;String,double[]&gt;
|Map&lt;String,String&gt;
|
|
|-
|-
|calcTimeMS
|legend
|long
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|colorMultiplier
|maquetteOverride
|double
|Map&lt;String,double[]&gt;
|
|
|-
|-
|colorOffset
|maxValue
|int
|float[]
|
|
|-
|-
|customLegend
|minValue
|boolean
|float[]
|
|
|-
|-
|diffLegend
|model
|LegendEntry<nowiki>[]</nowiki>
|HeatModel
|
|
|-
|-
|formula
|name
|String
|String
|
|
|-
|-
|id
|parentID
|int
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|imageName
|resultType
|String
|String
|
|
|-
|-
|imageVersion
|showDifference
|boolean
|
|-
|sortIndex
|int
|int
|
|
|-
|-
|inActiveCellSize
|type
|double
|OverlayType
|
|
|-
|-
|inActiveTimeframes
|version
|int
|int
|
|
|-
|-
|keys
|visible
|Map&lt;String,String&gt;
|boolean
|
|
|-
|-
|layerMapLink
|warnings
|MapLink
|String
|
|
|}
==Api Model HeightOverlay==
API Model description of HeightOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|legend
|active
|LegendEntry<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|maquetteOverride
|attributes
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|
|-
|-
|maxValue
|calcTimeMS
|float[]
|long
|
|
|-
|-
|minValue
|colorMultiplier
|float[]
|double
|
|
|-
|-
|name
|colorOffset
|String
|int
|
|
|-
|-
|parentID
|customLegend
|int
|boolean
|[[Overlay]] ID
|
|-
|-
|prequels
|diffLegend
|Map&lt;String,PrequelLink&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|rasterization
|id
|Rasterization
|int
|
|
|-
|-
|resultType
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|String
|
|
Line 1,751: Line 1,836:
|}
|}


==Api Model ConstructionPeriod==
==Api Model ImageOverlay==
API Enumeration description of ConstructionPeriod
API Model description of ImageOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ANCIENT
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|CLASSIC
|colorMultiplier
|double
|
|
|-
|-
|PRE_WAR
|colorOffset
|int
|
|
|-
|-
|POST_WAR
|customLegend
|boolean
|
|
|-
|-
|CONTEMPORARY
|id
|int
|
|
|-
|-
|FUTURISTIC
|imageName
|String
|
|
|}
==Api Model CoreStakeholder==
API Model description of CoreStakeholder
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
|imageNames
|boolean
|String<nowiki>[]</nowiki>
|
|
|-
|-
|client
|imageVersion
|ClientData
|int
|
|
|-
|-
|color
|legend
|TColor
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|id
|maquetteOverride
|int
|Map&lt;String,double[]&gt;
|
|-
|lastSelected
|long
|
|
|-
|-
Line 1,809: Line 1,888:
|
|
|-
|-
|version
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|int
|
|
|-
|-
|webToken
|type
|String
|OverlayType
|
|-
|version
|int
|
|
|}
==Api Model CostType==
API Enumeration description of CostType
{|class=wikitable
!Name
!Description
|-
|-
|CONSTRUCTION
|visible
|boolean
|
|
|}
|}


==Api Model CustomColorArea==
==Api Model InferenceOverlay==
API Model description of CustomColorArea
API Model description of InferenceOverlay


{|class=wikitable
{|class=wikitable
Line 1,837: Line 1,917:
!Description
!Description
|-
|-
|color
|active
|TColor
|boolean
|
|
|-
|-
|name
|attributes
|String
|Map&lt;String,double[]&gt;
|
|
|-
|-
|polygons
|calcTimeMS
|MultiPolygon
|long
|
|
|-
|-
|zoneID
|colorMultiplier
|int
|double
|
|
|}
==Api Model CustomGeometry==
API Model description of CustomGeometry
{|class=wikitable
!Name
!Type
!Description
|-
|-
|absoluteHeight
|colorOffset
|boolean
|int
|
|
|-
|-
|backFaceCulling
|customLegend
|boolean
|boolean
|
|
|-
|-
|color
|diffLegend
|TColor
|LegendEntry<nowiki>[]</nowiki>
|
|-
|data
|float[]
|
|
|-
|-
Line 1,882: Line 1,949:
|
|
|-
|-
|texture
|imageName
|String
|String
|
|
|-
|-
|version
|imageVersion
|int
|int
|
|
|}
==Api Model DataType==
API Enumeration description of DataType
{|class=wikitable
!Name
!Description
|-
|-
|FLOAT
|inActiveCellSize
|double
|
|
|-
|-
|DOUBLE
|inActiveTimeframes
|int
|
|
|-
|-
|INT8
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|INT16
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|INT32
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|INT64
|maxValue
|float[]
|
|
|-
|-
|BOOL
|minValue
|float[]
|
|
|-
|-
|STRING
|name
|String
|
|
|-
|-
|UINT8
|neuralNetworkID
|
|int
|[[Neural Network]] ID
|-
|-
|FLOAT16
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|BFLOAT16
|resultType
|String
|
|
|-
|-
|UNKNOWN
|showDifference
|boolean
|
|
|}
==Api Model DefaultAttribute==
API Enumeration description of DefaultAttribute
{|class=wikitable
!Name
!Description
|-
|-
|ATTRIBUTE
|sortIndex
|int
|
|
|}
==Api Model DefaultNeuralNetwork==
API Model description of DefaultNeuralNetwork
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attributes
|tensorLinks
|Map&lt;String,double[]&gt;
|TensorLink<nowiki>[]</nowiki>
|
|
|-
|-
|description
|type
|String
|OverlayType
|
|
|-
|-
|id
|version
|int
|int
|
|
|-
|-
|legendEntries
|visible
|LegendEntry<nowiki>[]</nowiki>
|boolean
|
|
|-
|-
|name
|warnings
|String
|String
|
|
|}
==Api Model IterationOverlay==
API Model description of IterationOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|override
|active
|boolean
|boolean
|
|
|-
|-
|producer
|attributes
|String
|Map&lt;String,double[]&gt;
|
|-
|tensors
|Tensor<nowiki>[]</nowiki>
|
|-
|uploadDate
|long
|
|-
|uploaderName
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
 
==Api Model DefaultOverlay==
API Model description of DefaultOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
Line 2,120: Line 2,151:
|}
|}


==Api Model DefaultRasterizationOverlay==
==Api Model LegendEntry==
API Model description of DefaultRasterizationOverlay
API Model description of LegendEntry


{|class=wikitable
{|class=wikitable
Line 2,128: Line 2,159:
!Description
!Description
|-
|-
|active
|color
|boolean
|TColor
|
|
|-
|-
|attributes
|entryName
|Map&lt;String,double[]&gt;
|String
|
|
|-
|-
|calcTimeMS
|id
|long
|int
|
|
|-
|-
|colorMultiplier
|value
|double
|float
|
|
|-
|}
|colorOffset
 
|int
==Api Model Mode==
API Enumeration description of Mode
 
{|class=wikitable
!Name
!Description
|-
|SPEED
|
|-
|AVERAGE
|
|-
|ACCURACY
|
|}
 
==Api Model NO2Overlay==
API Model description of NO2Overlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|
|-
|-
Line 2,178: Line 2,251:
|keys
|keys
|Map&lt;String,String&gt;
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|
|-
|-
Line 2,210: Line 2,279:
|prequels
|prequels
|Map&lt;String,PrequelLink&gt;
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|
|-
|-
Line 2,245: Line 2,310:
|}
|}


==Api Model DefaultResult==
==Api Model NetOverlay==
API Enumeration description of DefaultResult
API Model description of NetOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|DEFAULT
|attributes
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model DefaultSource==
API Model description of DefaultSource
{|class=wikitable
!Name
!Type
!Description
|-
|-
|color
|colorMultiplier
|TColor
|double
|
|
|-
|-
|date
|colorOffset
|long
|int
|
|
|-
|-
|description
|customLegend
|String
|boolean
|
|
|-
|-
Line 2,280: Line 2,338:
|
|
|-
|-
|infoUrl
|imageName
|String
|String
|
|
|-
|-
|name
|imageVersion
|String
|int
|
|
|-
|-
|uploaderName
|legend
|String
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|version
|maquetteOverride
|int
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model DesignAttribute==
API Enumeration description of DesignAttribute
{|class=wikitable
!Name
!Description
|-
|-
|BACKYARD_DISTANCE_M
|name
|String
|
|
|-
|-
|WATER_WIDTH_M
|netType
|NetType
|
|
|-
|-
|KEEP_EXISTING_ROADS
|parentID
|
|int
|[[Overlay]] ID
|-
|-
|ROAD_WIDTH_M
|showActive
|boolean
|
|
|-
|-
|ROAD_DISTANCE_Y_M
|showNetwork
|boolean
|
|
|-
|-
|ROAD_SEARCH_DISTANCE_M
|sortIndex
|int
|
|
|-
|-
|SIDEWALK_WIDTH_M
|type
|OverlayType
|
|
|-
|-
|PARKING_WIDTH_M
|version
|int
|
|
|-
|-
|PARKING_LENGTH_M
|visible
|
|boolean
|-
|FRACTION_BUILDINGS
|
|-
|FRACTION_ROADS
|
|-
|FRACTION_WATER
|
|-
|FRACTION_PUBLIC_GREEN
|
|-
|FRACTION_GARDENS
|
|-
|FRACTION_PARKING
|
|-
|FRACTION_REMAINDER
|
|
|}
|}


==Api Model Detail==
==Api Model NetType==
API Enumeration description of Detail
API Enumeration description of NetType


{|class=wikitable
{|class=wikitable
Line 2,360: Line 2,398:
!Description
!Description
|-
|-
|CONSTRUCTION_COST
|ELECTRICITY
|
|
|-
|-
|DEMOLISH_COST
|GAS
|
|
|-
|-
|BUYOUT_COST
|HEAT
|
|
|-
|-
|SELL_PRICE
|INTERNET
|
|
|-
|-
|SELLABLE_FLOORSPACE_M2
|SEWER
|
|-
|NUMBER_OF_HOUSES
|
|
|}
|}


==Api Model DischargeMethod==
==Api Model NoiseOverlay==
API Enumeration description of DischargeMethod
API Model description of NoiseOverlay
 
{|class=wikitable
!Name
!Description
|-
|HEIGHT_MINIMA
|
|-
|WATER_TERRAINS
|
|-
|AREAS
|
|}
 
==Api Model DistanceOverlay==
API Model description of DistanceOverlay


{|class=wikitable
{|class=wikitable
Line 2,454: Line 2,472:
|keys
|keys
|Map&lt;String,String&gt;
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|
|-
|-
Line 2,486: Line 2,500:
|prequels
|prequels
|Map&lt;String,PrequelLink&gt;
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|
|-
|-
Line 2,521: Line 2,531:
|}
|}


==Api Model DistanceResult==
==Api Model Overlay==
API Enumeration description of DistanceResult
API Model description of Overlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ZONE
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|SIGHT
|colorMultiplier
|double
|
|
|}
==Api Model EmptyMultiPolygon==
API Model description of EmptyMultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model EnergyLabel==
API Enumeration description of EnergyLabel
{|class=wikitable
!Name
!Description
|-
|-
|UNKNOWN
|colorOffset
|int
|
|
|-
|-
|G
|customLegend
|boolean
|
|
|-
|-
|F
|id
|int
|
|
|-
|-
|E
|imageName
|String
|
|
|-
|-
|D
|imageVersion
|int
|
|
|-
|-
|C
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|B
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|A0
|name
|String
|
|
|-
|-
|A1
|parentID
|
|int
|[[Overlay]] ID
|-
|-
|A2
|sortIndex
|int
|
|
|-
|-
|A3
|type
|OverlayType
|
|
|-
|-
|A4
|version
|int
|
|
|-
|-
|A5
|visible
|boolean
|
|
|}
|}


==Api Model EventBundle==
==Api Model OverlayType==
API Model description of EventBundle
API Enumeration description of OverlayType


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|clientEvents
|OWNERSHIP
|CodedEvent<nowiki>[]</nowiki>
|
|
|-
|-
|compoundEventBundleIDs
|OWNERSHIP_GRID
|int<nowiki>[]</nowiki>
|
|[[Event Bundle]] ID
|-
|-
|description
|ZIP_CODES
|String
|
|
|-
|-
|id
|ZONING
|int
|
|
|-
|-
|imageName
|NEIGHBORHOODS
|String
|
|
|-
|-
|imageVersion
|MUNICIPALITIES
|int
|
|
|-
|-
|name
|SCENARIO
|String
|
|
|-
|-
|serverEvents
|VACANCY
|CodedEvent<nowiki>[]</nowiki>
|
|
|-
|-
|version
|HEAT_STRESS
|int
|
|
|}
==Api Model Example==
API Enumeration description of Example
{|class=wikitable
!Name
!Description
|-
|-
|CITY_NEIGHBORHOOD
|SHADOW
|
|
|-
|-
|URBAN_NEIGHBORHOOD
|TRAFFIC_DENSITY
|
|
|-
|-
|SUBURBAN_NEIGHBORHOOD
|TRAFFIC_NO2
|
|
|-
|-
|WINDMILL_AREA
|TRAFFIC_NOISE
|
|
|}
==Api Model ExcelPanel==
API Model description of ExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|-
|answers
|LIVABILITY
|Answer<nowiki>[]</nowiki>
|
|
|-
|-
|attributes
|AERIUS
|Map&lt;String,double[]&gt;
|
|
|-
|-
|calcTimeMS
|RAINFALL
|long
|
|
|-
|-
|contentID
|FLOODING
|int
|
|
|-
|-
|contentMapLink
|GROUNDWATER
|MapLink
|
|
|-
|-
|excelID
|WATERSHED
|int
|
|[[Excel Sheet]] ID
|-
|-
|height
|SUBSIDENCE
|double
|
|
|-
|-
|id
|WATERWIJZER
|int
|
|
|-
|-
|layoutX
|AVG
|double
|
|
|-
|-
|layoutY
|COMBO
|double
|
|
|-
|-
|maquetteOverride
|DISTANCE
|Map&lt;String,double[]&gt;
|
|
|-
|-
|name
|SIGHT_DISTANCE
|String
|
|
|-
|-
|overlayID
|TRAVEL_DISTANCE
|int
|
|[[Overlay]] ID
|-
|-
|overrideDefaultAnswerID
|INFERENCE
|int
|
|
|-
|-
|parentID
|ITERATION
|int
|
|
|-
|-
|point
|GEO_TIFF
|Point
|
|
|-
|-
|polygons
|WMS
|MultiPolygon
|
|
|-
|-
|stakeholderID
|WCS
|int
|
|[[Stakeholder]] ID
|-
|-
|text
|IMAGE
|String
|
|
|-
|-
|type
|AREA
|PanelType
|
|
|-
|-
|updateTiming
|ATTRIBUTE
|Timing
|
|
|-
|-
|version
|FUNCTION
|int
|
|
|-
|-
|warnings
|SATELLITE
|String
|
|
|-
|-
|width
|HEIGHTMAP
|double
|
|
|}
==Api Model FaceType==
API Enumeration description of FaceType
{|class=wikitable
!Name
!Description
|-
|-
|BASEMENT
|UNDERGROUND
|
|
|-
|-
|GROUND
|SOURCE
|
|
|-
|-
|EXTRA
|NETWORK_OWNERSHIP
|
|
|-
|-
|TOP
|NETWORK_OVERVIEW
|
|
|-
|-
|ROOF
|NETWORK_DISTANCE
|
|
|}
==Api Model FloodingOverlay==
API Model description of FloodingOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
|RESULT_CHILD
|boolean
|
|-
|TEST
|
|-
|DISTURBANCE_DISTANCE
|
|-
|SAFETY_DISTANCE
|
|-
|DEPRECATED
|
|}
 
==Api Model RainOverlay==
API Model description of RainOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|
|-
|-
Line 2,921: Line 2,886:
|}
|}


==Api Model FunctionChangeGeoLink==
==Api Model Rasterization==
API Model description of FunctionChangeGeoLink
API Enumeration description of Rasterization


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|add
|FIRST
|boolean
|
|
|-
|-
|category
|MIN
|Category
|
|
|-
|-
|featureAttributes
|MAX
|Map&lt;String,java.util.List<java.lang.String>&gt;
|
|
|-
|-
|functionID
|SINGLE_LAYER
|int
|[[Function]] ID
|-
|id
|int
|
|
|-
|-
|priority
|GRID
|int
|
|-
|tree
|boolean
|
|-
|update
|boolean
|
|-
|version
|int
|
|
|}
|}


==Api Model FunctionOverlay==
==Api Model RasterizationOverlay==
API Model description of FunctionOverlay
API Model description of RasterizationOverlay


{|class=wikitable
{|class=wikitable
Line 2,974: Line 2,917:
!Description
!Description
|-
|-
|attributes
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|
|-
|-
Line 2,990: Line 2,941:
|
|
|-
|-
|functionIDs
|diffLegend
|int<nowiki>[]</nowiki>
|LegendEntry<nowiki>[]</nowiki>
|[[Function]] ID
|-
|functionsColor
|TColor
|
|
|-
|-
Line 3,008: Line 2,955:
|imageVersion
|imageVersion
|int
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|
|-
|-
Line 3,016: Line 2,979:
|maquetteOverride
|maquetteOverride
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|
|-
|-
Line 3,026: Line 2,997:
|[[Overlay]] ID  
|[[Overlay]] ID  
|-
|-
|remainderColor
|prequels
|TColor
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|
|-
|-
Line 3,044: Line 3,027:
|visible
|visible
|boolean
|boolean
|
|-
|warnings
|String
|
|
|}
|}


==Api Model FunctionOverride==
==Api Model ResultChildOverlay==
API Model description of FunctionOverride
API Model description of ResultChildOverlay


{|class=wikitable
{|class=wikitable
Line 3,054: Line 3,041:
!Type
!Type
!Description
!Description
|-
|active
|boolean
|
|-
|-
|attributes
|attributes
Line 3,059: Line 3,050:
|
|
|-
|-
|categories
|calcTimeMS
|Category<nowiki>[]</nowiki>
|long
|
|
|-
|-
|description
|colorMultiplier
|String
|double
|
|
|-
|-
|id
|colorOffset
|int
|int
|
|
|-
|-
|imageName
|customLegend
|String
|boolean
|
|
|-
|-
|imageVersion
|diffLegend
|int
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|maquetteOverride
|id
|Map&lt;String,double[]&gt;
|int
|
|
|-
|-
|name
|imageName
|String
|String
|
|
|-
|-
|version
|imageVersion
|int
|int
|
|
|}
==Api Model FunctionType==
API Enumeration description of FunctionType
{|class=wikitable
!Name
!Description
|-
|-
|ROAD
|inActiveCellSize
|double
|
|
|-
|-
|WATER
|inActiveTimeframes
|int
|
|
|-
|-
|PARKING
|keys
|Map&lt;String,String&gt;
|
|
|-
|-
|SIDEWALK
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|BUILDING
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|GARDEN
|maxValue
|float[]
|
|
|-
|-
|PUBLIC_GREEN
|minValue
|float[]
|
|
|-
|-
|REMAINDER
|name
|String
|
|
|}
==Api Model GasType==
API Enumeration description of GasType
{|class=wikitable
!Name
!Description
|-
|-
|NOX
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|NO2
|resultType
|String
|
|
|}
==Api Model GeoFormat==
API Enumeration description of GeoFormat
{|class=wikitable
!Name
!Description
|-
|-
|GEOJSON
|showDifference
|boolean
|
|
|-
|-
|GEOPACKAGE
|sortIndex
|int
|
|
|-
|-
|WFS_JSON
|type
|OverlayType
|
|
|-
|-
|WFS_GML
|version
|int
|
|
|-
|-
|WMS_IMAGE
|visible
|boolean
|
|
|-
|-
|WCS_TIFF
|warnings
|String
|
|
|}
==Api Model ResultParentOverlay==
API Model description of ResultParentOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|OSM
|active
|boolean
|
|
|-
|-
|BGT_GML
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|ESRI_JSON
|calcTimeMS
|long
|
|
|-
|-
|ESRI_IMAGE
|colorMultiplier
|double
|
|
|-
|-
|CYCLO_IMAGE
|colorOffset
|int
|
|
|-
|-
|I3S
|customLegend
|boolean
|
|
|-
|-
|GEOTIFF
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|DXF
|id
|int
|
|
|}
==Api Model GeoTiffAttribute==
API Enumeration description of GeoTiffAttribute
{|class=wikitable
!Name
!Description
|-
|-
|BAND
|imageName
|String
|
|
|}
==Api Model GeoTiffFeature==
API Model description of GeoTiffFeature
{|class=wikitable
!Name
!Type
!Description
|-
|-
|id
|imageVersion
|int
|int
|
|
|-
|-
|version
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|int
|
|
|}
==Api Model GeoTiffOverlay==
API Model description of GeoTiffOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
|keys
|boolean
|Map&lt;String,String&gt;
|
|
|-
|-
|attributes
|legend
|Map&lt;String,double[]&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|calcTimeMS
|maquetteOverride
|long
|Map&lt;String,double[]&gt;
|
|
|-
|-
|colorMultiplier
|maxValue
|double
|float[]
|
|
|-
|-
|colorOffset
|minValue
|int
|float[]
|
|
|-
|-
|customLegend
|name
|boolean
|String
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|geoTiffIDs
|int<nowiki>[]</nowiki>
|[[GeoTIFF]] ID
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|
|-
|-
Line 3,337: Line 3,268:
|}
|}


==Api Model GeoTiffResult==
==Api Model SatelliteOverlay==
API Enumeration description of GeoTiffResult
API Model description of SatelliteOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|NEAREST
|active
|boolean
|
|
|-
|-
|INTERPOLATED
|attributes
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model GeoTiffSpatial==
API Model description of GeoTiffSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|-
|autoMP
|calcTimeMS
|boolean
|long
|
|
|-
|-
|geoTiffIDs
|colorMultiplier
|int<nowiki>[]</nowiki>
|double
|[[GeoTIFF]] ID
|-
|id
|int
|
|
|-
|-
|multiPolygon
|colorOffset
|MultiPolygon
|
|-
|terrainTypeID
|int
|int
|
|
|}
==Api Model GeometryCollection==
API Model description of GeometryCollection
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model Global==
API Model description of Global
{|class=wikitable
!Name
!Type
!Description
|-
|-
|actualValue
|customLegend
|double[]
|boolean
|
|
|-
|-
|bookValueStakeholderID
|diffLegend
|int
|LegendEntry<nowiki>[]</nowiki>
|[[Stakeholder]] ID
|-
|calcTimeMS
|long
|
|
|-
|-
Line 3,413: Line 3,308:
|
|
|-
|-
|name
|imageName
|String
|String
|
|
|-
|-
|point
|imageVersion
|Point
|int
|
|
|-
|-
|previousValue
|inActiveCellSize
|double[]
|double
|
|
|-
|-
|query
|inActiveTimeframes
|String
|int
|
|
|-
|-
|queryTiming
|keys
|Timing
|Map&lt;String,String&gt;
|
|
|-
|-
|startValue
|legend
|double[]
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|version
|maquetteOverride
|int
|
|-
|visualisationName
|String
|
|}
 
==Api Model GlobalPanel==
API Model description of GlobalPanel
 
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|
|-
|-
|globalIDs
|maxValue
|int<nowiki>[]</nowiki>
|float[]
|[[Global]] ID
|-
|height
|double
|
|
|-
|-
|id
|minValue
|int
|float[]
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
Line 3,490: Line 3,348:
|
|
|-
|-
|overlayID
|parentID
|int
|int
|[[Overlay]] ID  
|[[Overlay]] ID  
|-
|-
|overrideDefaultAnswerID
|prequels
|int
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|
|-
|-
|point
|showDifference
|Point
|boolean
|
|
|-
|-
|stakeholderID
|sortIndex
|int
|int
|[[Stakeholder]] ID
|
|-
|-
|type
|type
|PanelType
|OverlayType
|
|
|-
|-
Line 3,514: Line 3,376:
|
|
|-
|-
|width
|visible
|double
|boolean
|
|
|}
==Api Model GridFeature==
API Model description of GridFeature
{|class=wikitable
!Name
!Type
!Description
|-
|-
|id
|warnings
|int
|String
|
|-
|version
|int
|
|
|}
|}


==Api Model GridModelAttribute==
==Api Model ServiceOverlay==
API Enumeration description of GridModelAttribute
API Model description of ServiceOverlay
 
{|class=wikitable
!Name
!Description
|-
|ITERATION_ACTIVE
|
|-
|SKIP_NO_DATA
|
|-
|GPU_CLUSTER_INDEX
|
|}
 
==Api Model GridOverlay==
API Model description of GridOverlay


{|class=wikitable
{|class=wikitable
Line 3,579: Line 3,411:
|colorOffset
|colorOffset
|int
|int
|
|-
|crs
|String
|
|
|-
|-
Line 3,587: Line 3,423:
|diffLegend
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|
|-
|-
Line 3,611: Line 3,451:
|keys
|keys
|Map&lt;String,String&gt;
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|
|-
|-
Line 3,652: Line 3,500:
|int
|int
|
|
|-
|sourceID
|int
|[[Source]] ID
|-
|-
|type
|type
Line 3,670: Line 3,522:
|}
|}


==Api Model GridSpatial==
==Api Model ShadowOverlay==
API Model description of GridSpatial
API Model description of ShadowOverlay


{|class=wikitable
{|class=wikitable
Line 3,678: Line 3,530:
!Description
!Description
|-
|-
|autoMP
|active
|boolean
|boolean
|
|
|-
|-
|id
|attributes
|int
|
|-
|multiPolygon
|MultiPolygon
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|terrainTypeID
|int
|
|}
 
==Api Model GroundwaterOverlay==
API Model description of GroundwaterOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|
Line 3,777: Line 3,600:
|minValue
|minValue
|float[]
|float[]
|
|-
|mode
|Mode
|
|
|-
|-
Line 3,797: Line 3,616:
|resultType
|resultType
|String
|String
|
|-
|showAreas
|boolean
|
|
|-
|-
|showDifference
|showDifference
|boolean
|
|-
|showSystem
|boolean
|boolean
|
|
Line 3,830: Line 3,641:
|String
|String
|
|
|-
|weatherID
|int
|[[Weather]] ID
|}
|}


==Api Model Group (SpecialOption)==
==Api Model SourceOverlay==
API Enumeration description of Group
API Model description of SourceOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|LAND
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|SCULPTING
|colorMultiplier
|double
|
|
|-
|-
|FINANCE
|colorOffset
|int
|
|
|-
|-
|DEMOLISH
|customLegend
|boolean
|
|-
|id
|int
|
|
|}
==Api Model HeatDpraAttribute==
API Enumeration description of HeatDpraAttribute
{|class=wikitable
!Name
!Description
|-
|-
|DATES
|imageName
|String
|
|
|-
|-
|DAILY_AVG_RADIATION
|imageVersion
|int
|
|
|-
|-
|DAILY_TEMPERATURE_MAX
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|DAILY_TEMPERATURE_MIN
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|EXCLUDE_BUILDINGS
|name
|String
|
|
|-
|-
|EXCLUDE_WATER
|parentID
|
|int
|[[Overlay]] ID
|-
|-
|EXCLUDE_FOLIAGE_HEIGHT_M
|restColor
|TColor
|
|
|-
|-
|FOLIAGE_AREAS
|sortIndex
|int
|
|
|-
|-
|HOURLY_RADIATION
|sources
|Map&lt;int,int&gt;
|
|
|-
|-
|HOURLY_TEMPERATURE
|type
|OverlayType
|
|
|-
|-
|HOURLY_HUMIDITY
|version
|int
|
|
|-
|-
|SUN_ALTITUDE
|visible
|boolean
|
|
|}
==Api Model SubsidenceOverlay==
API Model description of SubsidenceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|SUN_AZIMUTH
|active
|boolean
|
|
|-
|-
|SUN_DAILY_MOTION
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|WIND_DIRECTION
|calcTimeMS
|long
|
|
|-
|-
|WIND_SPEED
|colorMultiplier
|double
|
|
|-
|-
|DAILY_AVG_WIND_SPEED
|colorOffset
|int
|
|
|-
|-
|MAX_SHADOW_DISTANCE
|customLegend
|boolean
|
|
|-
|-
|MAX_TRUNK_DISTANCE
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|WIND_DECLINE_ANGLE
|id
|
|int
|}
 
==Api Model HeatKey==
API Enumeration description of HeatKey
 
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|
|}
==Api Model HeatModel==
API Enumeration description of HeatModel
{|class=wikitable
!Name
!Description
|-
|-
|UNESCO
|imageName
|String
|
|
|-
|-
|DPRA
|imageVersion
|int
|
|
|}
==Api Model HeatOverlay==
API Model description of HeatOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
|inActiveCellSize
|boolean
|double
|
|
|-
|-
|attributes
|inActiveTimeframes
|Map&lt;String,double[]&gt;
|int
|
|
|-
|-
|calcInfo
|keys
|String
|Map&lt;String,String&gt;
|
|
|-
|-
|calcTimeMS
|legend
|long
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|colorMultiplier
|maquetteOverride
|double
|Map&lt;String,double[]&gt;
|
|
|-
|-
|colorOffset
|maxValue
|int
|float[]
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|
|-
|-
|minValue
|minValue
|float[]
|float[]
|
|-
|model
|HeatModel
|
|
|-
|-
Line 4,074: Line 3,837:
|}
|}


==Api Model HeatPrequel==
==Api Model TColor==
API Enumeration description of HeatPrequel
API Model description of TColor


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|}
|FOLIAGE_HEIGHT
 
|
==Api Model TensorLink==
|-
API Model description of TensorLink
|BUILDING_ELEVATION
|
|-
|TERRAIN_ELEVATION
|
|}
 
==Api Model HeatResult==
API Enumeration description of HeatResult


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|BOWEN_RATIO
|coordinate
|int[]
|
|
|-
|-
|FOLIAGE
|id
|int
|
|
|-
|-
|PET
|normalized
|boolean
|
|
|-
|-
|PET_RELATIVE
|prequel
|String
|
|
|-
|-
|SHADE
|result
|String
|
|
|-
|-
|SKY_VIEW
|tensorName
|String
|
|
|-
|-
|SKY_VIEW_AVG
|valueType
|
|ValueType
|-
|TEMPERATURE_ATMOSPHERE
|
|-
|UHI
|
|-
|VEGETATION
|
|-
|VEGETATION_AVG
|
|-
|WIND_SPEED
|
|
|}
|}


==Api Model HeightAttribute==
==Api Model TrafficDensityOverlay==
API Enumeration description of HeightAttribute
API Model description of TrafficDensityOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ZONING_PERMIT_REQUIRED
|attributes
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model HeightOperator==
API Enumeration description of HeightOperator
{|class=wikitable
!Name
!Description
|-
|-
|AVG
|colorMultiplier
|double
|
|
|-
|-
|MIN
|colorOffset
|int
|
|
|-
|-
|MAX
|customLegend
|boolean
|
|
|-
|-
|VOLUME
|id
|int
|
|
|-
|-
|STDEV
|imageName
|String
|
|
|-
|-
|AREA
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|
|}
|}


==Api Model HeightOverlay==
==Api Model TrafficOverlay==
API Model description of HeightOverlay
API Model description of TrafficOverlay


{|class=wikitable
{|class=wikitable
Line 4,289: Line 4,069:
|}
|}


==Api Model HeightResult==
==Api Model TravelDistanceOverlay==
API Enumeration description of HeightResult
API Model description of TravelDistanceOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|DSM
|active
|boolean
|
|
|-
|-
|DTM
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|FLOORS
|calcTimeMS
|long
|
|
|}
==Api Model HeightSector==
API Model description of HeightSector
{|class=wikitable
!Name
!Type
!Description
|-
|-
|changed
|colorMultiplier
|Boolean
|double
|
|
|-
|-
|envelope
|colorOffset
|Envelope
|
|-
|id
|int
|int
|
|
|-
|-
|name
|customLegend
|String
|boolean
|
|
|-
|-
|pointAreaM2
|diffLegend
|double
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|pointWidth
|id
|int[]
|int
|
|
|-
|-
|sourceIDs
|imageName
|int<nowiki>[]</nowiki>
|String
|[[Source]] ID
|-
|square
|MultiPolygon
|
|
|-
|-
|version
|imageVersion
|int
|int
|
|
|}
==Api Model HeightSquare==
API Model description of HeightSquare
{|class=wikitable
!Name
!Type
!Description
|-
|-
|x
|inActiveCellSize
|double
|double
|
|
|-
|-
|xMax
|inActiveTimeframes
|double
|int
|
|
|-
|-
|xMin
|keys
|double
|Map&lt;String,String&gt;
|
|
|-
|-
|y
|legend
|double
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|yMax
|maquetteOverride
|double
|Map&lt;String,double[]&gt;
|
|
|-
|-
|yMin
|maxValue
|double
|float[]
|
|
|}
==Api Model ImageAttribute==
API Enumeration description of ImageAttribute
{|class=wikitable
!Name
!Description
|-
|-
|ALPHA
|minValue
|float[]
|
|
|}
|-
 
|name
==Api Model ImageOverlay==
|String
API Model description of ImageOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|colorMultiplier
|parentID
|double
|
|-
|colorOffset
|int
|int
|
|[[Overlay]] ID
|-
|-
|customLegend
|prequels
|boolean
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|id
|resultType
|int
|
|-
|imageName
|String
|String
|
|
|-
|-
|imageNames
|showDifference
|String<nowiki>[]</nowiki>
|boolean
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|-
|sortIndex
|sortIndex
Line 4,466: Line 4,180:
|boolean
|boolean
|
|
|}
|-
|warnings
|String
|
|}
 
==Api Model ValueType==
API Enumeration description of ValueType
 
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|R
|
|-
|G
|
|-
|B
|
|-
|A
|
|}


==Api Model Indicator==
==Api Model WCSOverlay==
API Model description of Indicator
API Model description of WCSOverlay


{|class=wikitable
{|class=wikitable
Line 4,476: Line 4,217:
!Description
!Description
|-
|-
|absolute
|active
|boolean
|boolean
|
|
Line 4,488: Line 4,229:
|
|
|-
|-
|currentExplanation
|colorMultiplier
|String
|double
|
|-
|colorOffset
|int
|
|
|-
|-
|description
|crs
|String
|String
|
|
|-
|-
|exactNumberValues
|customLegend
|Map&lt;MapType,double&gt;
|boolean
|
|
|-
|-
|exactTextValues
|diffLegend
|Map&lt;MapType,String&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|excelID
|forceXY
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|boolean
|
|
Line 4,524: Line 4,265:
|
|
|-
|-
|isActive
|inActiveCellSize
|boolean
|double
|
|-
|inActiveTimeframes
|int
|
|
|-
|-
|mapTypeValues
|keys
|Map&lt;MapType,double&gt;
|Map&lt;String,String&gt;
|
|
|-
|-
|maquetteExplanation
|layerName
|String
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|maquetteOverride
|maquetteOverride
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|
|-
|-
Line 4,546: Line 4,307:
|parentID
|parentID
|int
|int
|[[Indicator]] ID  
|[[Overlay]] ID  
|-
|-
|shortName
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|String
|
|-
|showDifference
|boolean
|
|
|-
|-
Line 4,556: Line 4,325:
|
|
|-
|-
|stakeholderID
|sourceID
|int
|int
|[[Stakeholder]] ID  
|[[Source]] ID  
|-
|-
|targetDescriptions
|type
|String<nowiki>[]</nowiki>
|OverlayType
|
|
|-
|-
|targets
|version
|Map&lt;int,double[]&gt;
|int
|
|
|-
|-
|updateTiming
|visible
|Timing
|boolean
|
|-
|version
|int
|
|
|-
|-
Line 4,581: Line 4,346:
|}
|}


==Api Model IndicatorAttribute==
==Api Model WMSOverlay==
API Enumeration description of IndicatorAttribute
API Model description of WMSOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|FINANCE
|active
|boolean
|
|
|}
==Api Model InferenceAttribute==
API Enumeration description of InferenceAttribute
{|class=wikitable
!Name
!Description
|-
|-
|MASK_THRESHOLD
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|SCORE_THRESHOLD
|calcTimeMS
|long
|
|
|-
|-
|INFERENCE_MODE
|colorMultiplier
|double
|
|
|-
|-
|STRIDE_FRACTION
|colorOffset
|int
|
|
|-
|-
|BOX_OVERLAP
|crs
|String
|
|
|-
|-
|PRIORITIZE_LABELS
|customLegend
|
|-
|GPU_MEMORY_MB
|
|}
 
==Api Model InferenceMode==
API Enumeration description of InferenceMode
 
{|class=wikitable
!Name
!Description
|-
|CLASSIFICATION
|
|-
|BBOX_DETECTION
|
|}
 
==Api Model InferenceOverlay==
API Model description of InferenceOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|boolean
|
|
|-
|-
|attributes
|diffLegend
|Map&lt;String,double[]&gt;
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|calcTimeMS
|forceXY
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
Line 4,695: Line 4,414:
|
|
|-
|-
|legend
|layerName
|LegendEntry<nowiki>[]</nowiki>
|String
|
|
|-
|-
|maquetteOverride
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|Map&lt;String,double[]&gt;
|
|
Line 4,714: Line 4,441:
|String
|String
|
|
|-
|neuralNetworkID
|int
|[[Neural Network]] ID
|-
|-
|parentID
|parentID
Line 4,739: Line 4,462:
|
|
|-
|-
|tensorLinks
|sourceID
|TensorLink<nowiki>[]</nowiki>
|int
|
|[[Source]] ID
|-
|-
|type
|type
Line 4,760: Line 4,483:
|}
|}


==Api Model InferencePrequel==
==Api Model WWOverlay==
API Enumeration description of InferencePrequel
API Model description of WWOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|A
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|B
|colorMultiplier
|double
|
|
|-
|-
|C
|colorOffset
|int
|
|
|}
==Api Model InferenceResult==
API Enumeration description of InferenceResult
{|class=wikitable
!Name
!Description
|-
|-
|LABELS
|customLegend
|boolean
|
|
|-
|-
|SCORES
|id
|int
|
|
|-
|-
|BOXES
|imageName
|String
|
|
|-
|-
|MASKS
|imageVersion
|int
|
|
|-
|-
|DEBUG_GT_INSTANCES
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|CENTER_POINTS
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|}
==Api Model Input==
API Enumeration description of Input
{|class=wikitable
!Name
!Description
|-
|-
|A
|name
|String
|
|
|-
|-
|B
|parentID
|
|int
|[[Overlay]] ID
|-
|-
|C
|sortIndex
|int
|
|
|-
|-
|D
|type
|OverlayType
|
|
|-
|-
|E
|version
|int
|
|
|-
|-
|F
|visible
|
|boolean
|-
|G
|
|-
|H
|
|-
|I
|
|-
|J
|
|
|}
|}


==Api Model InstanceColor==
==Api Model WaterOverlay==
API Enumeration description of InstanceColor
API Model description of WaterOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|GRAY
|active
|boolean
|
|
|-
|-
|WHITE
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|VEGIE_GREEN
|calcInfo
|String
|
|
|-
|-
|GRAIN_YELLOW
|calcTimeMS
|long
|
|
|-
|-
|FLOWERS
|colorMultiplier
|double
|
|
|}
==Api Model Item==
API Model description of Item
{|class=wikitable
!Name
!Type
!Description
|-
|-
|id
|colorOffset
|int
|int
|
|
|-
|-
|version
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|int
|
|
|}
==Api Model ItemMeasurement==
API Model description of ItemMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|-
|id
|imageName
|String
|
|-
|imageVersion
|int
|int
|
|
|-
|-
|itemID
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|int
|
|
|-
|-
|key
|keys
|String
|Map&lt;String,String&gt;
|
|
|-
|-
|mapLink
|legend
|MapLink
|LegendEntry<nowiki>[]</nowiki>
|
|
|-
|-
|maqMax
|maquetteOverride
|double
|Map&lt;String,double[]&gt;
|
|
|-
|-
|maqMin
|maxValue
|double
|float[]
|
|
|-
|-
|max
|minValue
|double
|float[]
|
|
|-
|-
|min
|mode
|double
|Mode
|
|
|-
|-
Line 4,925: Line 4,640:
|
|
|-
|-
|overlayIDs
|parentID
|int<nowiki>[]</nowiki>
|int
|[[Overlay]] ID  
|[[Overlay]] ID  
|-
|-
|overlayMaqValues
|prequels
|Map&lt;int,float[]&gt;
|Map&lt;String,PrequelLink&gt;
|
|
|-
|-
|overlayValues
|resultType
|Map&lt;int,float[]&gt;
|String
|
|
|-
|-
|point
|showAreas
|Point
|boolean
|
|
|-
|-
|save
|showDifference
|boolean
|boolean
|
|
|-
|-
|sourceIDs
|showSystem
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|boolean
|
|
|-
|-
|version
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|int
|
|
|}
==Api Model IterationAttribute==
API Enumeration description of IterationAttribute
{|class=wikitable
!Name
!Description
|-
|-
|MODULUS
|visible
|boolean
|
|
|-
|-
|TIMEFRAME_TIMES
|warnings
|String
|
|
|-
|weatherID
|int
|[[Weather]] ID
|}
|}


==Api Model IterationOverlay==
==Api Model WatershedOverlay==
API Model description of IterationOverlay
API Model description of WatershedOverlay


{|class=wikitable
{|class=wikitable
Line 5,042: Line 4,759:
|maxValue
|maxValue
|float[]
|float[]
|
|-
|method
|DischargeMethod
|
|
|-
|-
Line 5,086: Line 4,807:
|warnings
|warnings
|String
|String
|
|}
==Api Model IterationPrequel==
API Enumeration description of IterationPrequel
{|class=wikitable
!Name
!Description
|-
|ITERATION
|
|}
==Api Model Layer==
API Enumeration description of Layer
{|class=wikitable
!Name
!Description
|-
|BRIDGE
|
|-
|SURFACE
|
|-
|UNDERGROUND
|
|}
==Api Model LegendEntry==
API Model description of LegendEntry
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|entryName
|String
|
|-
|id
|int
|
|-
|value
|float
|
|}
==Api Model LeveeFeature==
API Model description of LeveeFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model LeveeSpatial==
API Model description of LeveeSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|angleOverride
|double
|
|-
|heightOverride
|double
|
|-
|id
|int
|
|-
|isRelativeOverride
|Boolean
|
|-
|leveeID
|int
|[[Levee]] ID
|-
|multiPolygon
|MultiPolygon
|
|-
|sidePolygon
|MultiPolygon
|
|-
|topPolygon
|MultiPolygon
|
|}
==Api Model LimitType==
API Enumeration description of LimitType
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|NEIGHBORHOODS
|
|-
|MEASURE_NEIGHBORHOODS
|
|}
==Api Model LineMeasurement==
API Model description of LineMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|distances
|double[]
|
|-
|id
|int
|
|-
|lineSegment
|LineSegment
|
|-
|lineString
|LineString
|
|-
|maqMax
|double
|
|-
|maqMin
|double
|
|-
|maqValues
|Map&lt;int,java.util.ArrayList<float[]>&gt;
|
|-
|max
|double
|
|-
|min
|double
|
|-
|name
|String
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|save
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|
|-
|values
|Map&lt;int,java.util.ArrayList<float[]>&gt;
|
|-
|version
|int
|
|}
==Api Model LineString==
API Model description of LineString
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model LoadAttribute==
API Enumeration description of LoadAttribute
{|class=wikitable
!Name
!Description
|-
|CONNECTION_COST
|
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COUNT
|
|-
|FLOOR_SPACE_M2
|
|-
|TYPE
|
|-
|ROOT_LOAD
|
|-
|LOAD_COUNT
|
|-
|ADDRESS_COUNT
|
|-
|CONNECTION_FRACTION
|
|-
|PRESSURE_M_H2O_SUPPLY
|
|-
|PRESSURE_M_H2O_RETURN
|
|-
|TEMPERATURE_SUPPLY_DEGREES_CELSIUS
|
|}
==Api Model LoadCostSegment==
API Model description of LoadCostSegment
{|class=wikitable
!Name
!Type
!Description
|-
|baseCost
|double
|
|-
|incrCost
|double
|
|-
|minValue
|int
|
|}
==Api Model LoadParameterType==
API Enumeration description of LoadParameterType
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COST
|
|-
|CONNECTION
|
|-
|FLOOR_SPACE_M2
|
|}
==Api Model LoadType==
API Enumeration description of LoadType
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|COLLECTIVE
|
|-
|COLLECTIVE_TAP
|
|-
|COLLECTIVE_RADIATOR
|
|-
|COLLECTIVE_RADIATOR_TAP
|
|-
|INDIVIDUAL
|
|-
|LARGE_SCALE_CONSUMER
|
|}
==Api Model LogicPanel==
API Model description of LogicPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model MapMeasure==
API Model description of MapMeasure
{|class=wikitable
!Name
!Type
!Description
|-
|actualHeightChangeM3
|double
|
|-
|buildingIDs
|int<nowiki>[]</nowiki>
|[[Building]] ID
|-
|buildingPermitProcessed
|Set
|
|-
|center
|Point
|
|-
|clientActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|confirmationsRequired
|boolean
|
|-
|constructionCostsFixed
|double
|
|-
|constructionCostsM3
|double
|
|-
|custom
|boolean
|
|-
|dependencyIDs
|int<nowiki>[]</nowiki>
|[[Measure]] ID
|-
|description
|String
|
|-
|geoTiffSpatials
|GeoTiffSpatial<nowiki>[]</nowiki>
|
|-
|gridSpatials
|GridSpatial<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|incomeFixed
|double
|
|-
|landOwnerPermissions
|Map&lt;int,Boolean&gt;
|
|-
|leveeSpatials
|LeveeSpatial<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|serverActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|state
|TimeState
|
|-
|terrainSpatials
|TerrainSpatial<nowiki>[]</nowiki>
|
|-
|upgradeSpatials
|UpgradeSpatial<nowiki>[]</nowiki>
|
|-
|version
|int
|
|}
==Api Model MapType==
API Enumeration description of MapType
{|class=wikitable
!Name
!Description
|-
|CURRENT
|
|-
|MAQUETTE
|
|}
==Api Model Measure==
API Model description of Measure
{|class=wikitable
!Name
!Type
!Description
|-
|clientActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|confirmationsRequired
|boolean
|
|-
|constructionCostsFixed
|double
|
|-
|custom
|boolean
|
|-
|dependencyIDs
|int<nowiki>[]</nowiki>
|[[Measure]] ID
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|incomeFixed
|double
|
|-
|landOwnerPermissions
|Map&lt;int,Boolean&gt;
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|serverActionEvents
|Map&lt;ActionType,java.util.List<nl.tytech.data.core.item.CodedEvent>&gt;
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|state
|TimeState
|
|-
|version
|int
|
|}
==Api Model MeasureEditType==
API Enumeration description of MeasureEditType
{|class=wikitable
!Name
!Description
|-
|BUILDING
|
|-
|RAISE
|
|-
|FLATTEN
|
|-
|WATER
|
|-
|UPGRADE
|
|-
|LEVEE
|
|-
|GEOTIFF
|
|-
|GRID
|
|}
==Api Model Method==
API Enumeration description of Method
{|class=wikitable
!Name
!Description
|-
|GET
|
|-
|POST
|
|}
==Api Model MinMax==
API Enumeration description of MinMax
{|class=wikitable
!Name
!Description
|-
|NEVER
|
|-
|LARGE_CELL
|
|-
|ALWAYS
|
|}
==Api Model Mode==
API Enumeration description of Mode
{|class=wikitable
!Name
!Description
|-
|SPEED
|
|-
|AVERAGE
|
|-
|ACCURACY
|
|}
==Api Model ModelData==
API Model description of ModelData
{|class=wikitable
!Name
!Type
!Description
|-
|additions
|Addition<nowiki>[]</nowiki>
|
|-
|animMultiplier
|double
|
|-
|buffer
|int
|
|-
|dimension
|int
|
|-
|frequency
|int
|
|-
|id
|int
|
|-
|instanceColor
|InstanceColor
|
|-
|isAlpha
|boolean
|
|-
|isShowCloseby
|boolean
|
|-
|modelHeight
|double
|
|-
|modelWidth
|double
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|placement
|Placement
|
|-
|randomScale
|double
|
|-
|roots
|boolean
|
|-
|rotation
|Rotation
|
|-
|show
|Show
|
|-
|variation
|int
|
|-
|version
|int
|
|}
==Api Model ModelStyle==
API Enumeration description of ModelStyle
{|class=wikitable
!Name
!Description
|-
|WIREFRAME
|
|-
|PLAIN
|
|-
|COLORED
|
|-
|TEXTURED
|
|-
|DISCO
|
|}
==Api Model MultiLineString==
API Model description of MultiLineString
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model MultiPolygon==
API Model description of MultiPolygon
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model NO2Overlay==
API Model description of NO2Overlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model NO2Result==
API Enumeration description of NO2Result
{|class=wikitable
!Name
!Description
|-
|CONCENTRATION
|
|-
|EMISSION_NO2
|
|-
|EMISSION_NOX
|
|-
|TREEFACTOR
|
|-
|TREES
|
|}
==Api Model NeighborPredicate==
API Model description of NeighborPredicate
{|class=wikitable
!Name
!Type
!Description
|-
|me
|Building
|
|}
==Api Model Neighborhood==
API Model description of Neighborhood
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|municipalityID
|int
|[[Stakeholder]] ID
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NeighborhoodAttribute==
API Enumeration description of NeighborhoodAttribute
{|class=wikitable
!Name
!Description
|-
|URBANIZATION
|
|-
|INHABITANTS
|
|-
|ACTIVE
|
|}
==Api Model NetFunction==
API Model description of NetFunction
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|diameterM
|double
|
|-
|groupName
|String
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|priceM
|double
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetLine==
API Model description of NetLine
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|endNodeID
|int
|[[Net Node]] ID
|-
|functionID
|int
|[[Net Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|startNodeID
|int
|[[Net Node]] ID
|-
|version
|int
|
|}
==Api Model NetLineAttribute==
API Enumeration description of NetLineAttribute
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|DIAMETER_M
|
|-
|ALWAYS_ACTIVE
|
|}
==Api Model NetLineFunctionAttribute==
API Enumeration description of NetLineFunctionAttribute
{|class=wikitable
!Name
!Description
|-
|PRICE_M
|
|-
|VISUALIZATION_DIAMETER_M
|
|-
|DIAMETER_M
|
|-
|COLOR
|
|}
==Api Model NetLoad==
API Model description of NetLoad
{|class=wikitable
!Name
!Type
!Description
|-
|addressIDs
|int<nowiki>[]</nowiki>
|[[Address]] ID
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|buildingID
|int
|[[Building]] ID
|-
|clusterID
|int
|[[Net Cluster]] ID
|-
|connectionState
|TimeState
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|nodeID
|int
|[[Net Node]] ID
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetNode==
API Model description of NetNode
{|class=wikitable
!Name
!Type
!Description
|-
|connectedLineIDs
|int<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|loadIDs
|int<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model NetOverlay==
API Model description of NetOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|showActive
|boolean
|
|-
|showNetwork
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model NetType==
API Enumeration description of NetType
{|class=wikitable
!Name
!Description
|-
|ELECTRICITY
|
|-
|GAS
|
|-
|HEAT
|
|-
|INTERNET
|
|-
|SEWER
|
|}
==Api Model NeuralNetwork==
API Model description of NeuralNetwork
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|id
|int
|
|-
|legendEntries
|LegendEntry<nowiki>[]</nowiki>
|
|-
|name
|String
|
|-
|producer
|String
|
|-
|tensors
|Tensor<nowiki>[]</nowiki>
|
|-
|uploadDate
|long
|
|-
|uploaderName
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
==Api Model NeuralNetworkAttribute==
API Enumeration description of NeuralNetworkAttribute
{|class=wikitable
!Name
!Description
|-
|MIN_CELL_SIZE_M
|
|-
|MAX_CELL_SIZE_M
|
|-
|MAX_GT_INSTANCES
|
|-
|VERSION
|
|}
==Api Model NoPrequel==
API Enumeration description of NoPrequel
{|class=wikitable
!Name
!Description
|}
==Api Model NoiseOverlay==
API Model description of NoiseOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model NoiseResult==
API Enumeration description of NoiseResult
{|class=wikitable
!Name
!Description
|-
|NOISE_DB
|
|-
|EMISSION
|
|}
==Api Model Operator (AvgOverlay)==
API Enumeration description of Operator
{|class=wikitable
!Name
!Description
|-
|AVG
|
|-
|AVG_INTERPOLATED
|
|-
|MAX
|
|-
|MIN
|
|}
==Api Model Operator (ComboOverlay)==
API Enumeration description of Operator
{|class=wikitable
!Name
!Description
|-
|SIN
|
|-
|COS
|
|-
|TAN
|
|-
|ASIN
|
|-
|ACOS
|
|-
|ATAN
|
|-
|SQRT
|
|-
|ROUND
|
|-
|FLOOR
|
|-
|CEIL
|
|-
|ABS
|
|-
|EXP
|
|-
|LN
|
|-
|LOG
|
|-
|RANDOM
|
|-
|ERF
|
|-
|GTE
|
|-
|GT
|
|-
|LTE
|
|-
|LT
|
|-
|NEQ
|
|-
|EQ
|
|-
|IF
|
|-
|AND
|
|-
|OR
|
|-
|SWITCH
|
|-
|ADD
|
|-
|MUL
|
|-
|DIV
|
|-
|SUB
|
|-
|MAX
|
|-
|MIN
|
|-
|AVG
|
|-
|POW
|
|-
|PERCENTILE
|
|-
|AVG_GTE_PERCENTILE
|
|-
|AVG_LTE_PERCENTILE
|
|-
|COLOR
|
|-
|RED
|
|-
|GREEN
|
|-
|BLUE
|
|-
|ALPHA
|
|}
==Api Model Outline==
API Enumeration description of Outline
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|SIMPLE
|
|-
|DASHED
|
|}
==Api Model Overlay==
API Model description of Overlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model OverlayCategory==
API Enumeration description of OverlayCategory
{|class=wikitable
!Name
!Description
|-
|ADMINISTRATIVE
|
|-
|ENVIRONMENTAL
|
|-
|WATER
|
|-
|GRID_CALCULATION
|
|-
|GEO_DATA
|
|-
|TOPOGRAPHY
|
|-
|NETWORKS
|
|}
==Api Model OverlayType==
API Enumeration description of OverlayType
{|class=wikitable
!Name
!Description
|-
|OWNERSHIP
|
|-
|OWNERSHIP_GRID
|
|-
|ZIP_CODES
|
|-
|ZONING
|
|-
|NEIGHBORHOODS
|
|-
|MUNICIPALITIES
|
|-
|SCENARIO
|
|-
|VACANCY
|
|-
|HEAT_STRESS
|
|-
|SHADOW
|
|-
|TRAFFIC_DENSITY
|
|-
|TRAFFIC_NO2
|
|-
|TRAFFIC_NOISE
|
|-
|LIVABILITY
|
|-
|AERIUS
|
|-
|RAINFALL
|
|-
|FLOODING
|
|-
|GROUNDWATER
|
|-
|WATERSHED
|
|-
|SUBSIDENCE
|
|-
|WATERWIJZER
|
|-
|AVG
|
|-
|COMBO
|
|-
|DISTANCE
|
|-
|SIGHT_DISTANCE
|
|-
|TRAVEL_DISTANCE
|
|-
|INFERENCE
|
|-
|ITERATION
|
|-
|GEO_TIFF
|
|-
|WMS
|
|-
|WCS
|
|-
|IMAGE
|
|-
|AREA
|
|-
|ATTRIBUTE
|
|-
|FUNCTION
|
|-
|SATELLITE
|
|-
|HEIGHTMAP
|
|-
|UNDERGROUND
|
|-
|SOURCE
|
|-
|NETWORK_OWNERSHIP
|
|-
|NETWORK_OVERVIEW
|
|-
|NETWORK_DISTANCE
|
|-
|RESULT_CHILD
|
|-
|TEST
|
|-
|DISTURBANCE_DISTANCE
|
|-
|SAFETY_DISTANCE
|
|-
|DEPRECATED
|
|}
==Api Model PDResult==
API Model description of PDResult
{|class=wikitable
!Name
!Type
!Description
|-
|areaExisting
|Map&lt;FunctionType,double&gt;
|
|-
|bandMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|-
|detailMPs
|Map&lt;FunctionType,java.util.Map<java.lang.Integer, java.util.List<org.locationtech.jts.geom.MultiPolygon>>&gt;
|
|}
==Api Model Panel==
API Model description of Panel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model PanelAttribute==
API Enumeration description of PanelAttribute
{|class=wikitable
!Name
!Description
|-
|VISIBLE
|
|-
|REFRESH
|
|-
|VISIBLE_TIMEFRAME
|
|-
|ATTENTION
|
|-
|SCALE
|
|-
|POPUP_TYPE
|
|}
==Api Model PanelTemplate==
API Enumeration description of PanelTemplate
{|class=wikitable
!Name
!Description
|-
|TRAFFIC_NOISE
|
|-
|DANGEROUS_OBJECTS
|
|-
|NETWORK_INTERACTION
|
|-
|WATER_AREAS
|
|-
|WEIRS
|
|}
==Api Model PanelType==
API Enumeration description of PanelType
{|class=wikitable
!Name
!Description
|-
|GLOBAL_PANEL
|
|-
|EXCEL_PANEL
|
|-
|WEB_PANEL
|
|-
|TEXT_PANEL
|
|-
|TEMPLATE_EXCEL_PANEL
|
|-
|TEMPLATE_TEXT_PANEL
|
|}
==Api Model ParametricDesign==
API Model description of ParametricDesign
{|class=wikitable
!Name
!Type
!Description
|-
|alignment
|Alignment
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|gardenID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parkingID
|int
|[[Function]] ID
|-
|plotDesigns
|PlotDesign<nowiki>[]</nowiki>
|
|-
|polygons
|MultiPolygon
|
|-
|publicGreenID
|int
|[[Function]] ID
|-
|roadID
|int
|[[Function]] ID
|-
|sidewalkID
|int
|[[Function]] ID
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|-
|waterID
|int
|[[Terrain Type]] ID
|}
==Api Model ParticleEmitterCoordinatePair==
API Model description of ParticleEmitterCoordinatePair
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|offsetCoordinate
|double[]
|
|-
|particleEmitterID
|int
|[[Particle Emitter]] ID
|}
==Api Model Placement==
API Enumeration description of Placement
{|class=wikitable
!Name
!Description
|-
|POINT
|
|-
|EDGE
|
|}
==Api Model PlacementType==
API Enumeration description of PlacementType
{|class=wikitable
!Name
!Description
|-
|WATER
|
|-
|LAND
|
|-
|HYBRID
|
|}
==Api Model Plot==
API Model description of Plot
{|class=wikitable
!Name
!Type
!Description
|-
|center
|Point
|
|-
|id
|int
|
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model PlotDesign==
API Model description of PlotDesign
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|functionID
|int
|[[Function]] ID
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|}
==Api Model PlotDesignAttribute==
API Enumeration description of PlotDesignAttribute
{|class=wikitable
!Name
!Description
|-
|AREA_M2
|
|-
|WIDTH_M
|
|-
|SIDE_DISTANCE_M
|
|-
|ROAD_DISTANCE_M
|
|-
|UNITS
|
|-
|FLOORS
|
|-
|FLOOR_HEIGHT_M
|
|-
|FIT_FRACTION
|
|-
|FRACTION
|
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model PointMeasurement==
API Model description of PointMeasurement
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|maqMax
|double
|
|-
|maqMin
|double
|
|-
|max
|double
|
|-
|min
|double
|
|-
|name
|String
|
|-
|overlayIDs
|int<nowiki>[]</nowiki>
|[[Overlay]] ID
|-
|overlayMaqValues
|Map&lt;int,float[]&gt;
|
|-
|overlayValues
|Map&lt;int,float[]&gt;
|
|-
|point
|Point
|
|-
|save
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|sum
|boolean
|
|-
|version
|int
|
|}
==Api Model PolygonAttributeItem==
API Model description of PolygonAttributeItem
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model PopupData==
API Model description of PopupData
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|calendar
|long
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|imageType
|PopupImageType
|
|-
|linkID
|int
|
|-
|linkType
|MapLink
|
|-
|modelDataID
|int
|[[Model Data]] ID
|-
|modelType
|PopupModelType
|
|-
|name
|String
|
|-
|opensAutomatically
|boolean
|
|-
|overrideAttention
|Boolean
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|scale
|double
|
|-
|text
|String
|
|-
|title
|String
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|visibleForStakeholderIDs
|int<nowiki>[]</nowiki>
|[[Stakeholder]] ID
|-
|visibleTimeframe
|int
|
|}
==Api Model PopupImageType==
API Enumeration description of PopupImageType
{|class=wikitable
!Name
!Description
|-
|PICK_DATE
|
|-
|REQUEST_PERMIT
|
|-
|RECEIVE_REQUEST
|
|-
|WAITING
|
|-
|DECLINE
|
|-
|APPROVE
|
|-
|WAIT_BUILD
|
|-
|WAIT_DEMOLISH
|
|-
|BUILD_PROGRESS
|
|-
|DEMOLISH_PROGRESS
|
|-
|BUY_LAND
|
|-
|SELL_LAND
|
|}
==Api Model PopupModelType==
API Enumeration description of PopupModelType
{|class=wikitable
!Name
!Description
|-
|APPROVED
|
|-
|ARROW
|
|-
|BUY
|
|-
|CONNECT_ON
|
|-
|CONNECT_OFF
|
|-
|CONSTRUCTING
|
|-
|ELEVATION
|
|-
|DECLINED
|
|-
|DEMOLISHING
|
|-
|WAITING
|
|-
|QUESTION_MARK
|
|-
|TRAFFIC_NOISE
|
|-
|WATER_CRANE
|
|-
|WATER_ARROW
|
|-
|WATER_WEIR
|
|-
|LIGHT_BULB
|
|-
|LIGHTNING
|
|-
|BAR_CHART
|
|-
|EXCLAMATION
|
|}
==Api Model RainOverlay==
API Model description of RainOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model Rasterization==
API Enumeration description of Rasterization
{|class=wikitable
!Name
!Description
|-
|FIRST
|
|-
|MIN
|
|-
|MAX
|
|-
|SINGLE_LAYER
|
|-
|GRID
|
|}
==Api Model RasterizationMethod==
API Enumeration description of RasterizationMethod
{|class=wikitable
!Name
!Description
|-
|COMBINED
|
|-
|OUTLINE
|
|-
|CENTER
|
|}
==Api Model RasterizationOverlay==
API Model description of RasterizationOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerMapLink
|MapLink
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|rasterization
|Rasterization
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model RasterizationPrequel==
API Enumeration description of RasterizationPrequel
{|class=wikitable
!Name
!Description
|-
|INPUT
|
|}
==Api Model Region==
API Enumeration description of Region
{|class=wikitable
!Name
!Description
|-
|NORTH_AMERICA
|
|-
|NORTHWESTERN_EUROPE
|
|-
|ASIA
|
|-
|AFRICA
|
|-
|OTHER
|
|}
==Api Model Relation==
API Enumeration description of Relation
{|class=wikitable
!Name
!Description
|-
|OWNER
|
|-
|CONSTRUCTOR
|
|-
|DEMOLISHER
|
|-
|PERMITTER
|
|-
|SENDER
|
|-
|RECEIVER
|
|-
|NETOWNER
|
|-
|BORDER_A
|
|-
|BORDER_B
|
|-
|BUILDING
|
|-
|WEATHER
|
|-
|PARENT
|
|-
|RESULT_PARENT
|
|}
==Api Model ResidenceType (Address)==
API Enumeration description of ResidenceType
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|DETACHED
|
|-
|SEMI_DETACHED
|
|-
|PORCH
|
|-
|TERRACED_BETWEEN
|
|-
|TERRACED_CORNER
|
|-
|TINY
|
|-
|GALLERY_HOUSE
|
|-
|FLAT
|
|-
|APARTMENT
|
|-
|CARAVAN
|
|-
|HOUSE_BOAT_BERTH
|
|-
|HOUSE_BOAT_NEW_BERTH
|
|-
|SHARED_HOUSE
|
|-
|ACCOMMODATION
|
|}
==Api Model ResultChildOverlay==
API Model description of ResultChildOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ResultParentOverlay==
API Model description of ResultParentOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model Rotation==
API Enumeration description of Rotation
{|class=wikitable
!Name
!Description
|-
|FIXED
|
|-
|QUARTER
|
|-
|FREE
|
|}
==Api Model SWRC==
API Enumeration description of SWRC
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|VAN_GENUCHTEN
|
|}
==Api Model SatelliteOverlay==
API Model description of SatelliteOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model Scenario==
API Model description of Scenario
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|description
|String
|
|-
|events
|CodedEvent<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|limitNeighborhoodIDs
|int<nowiki>[]</nowiki>
|[[Neighborhood]] ID
|-
|limitType
|LimitType
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|restartTestrun
|boolean
|
|-
|version
|int
|
|}
==Api Model ScenarioAttribute==
API Enumeration description of ScenarioAttribute
{|class=wikitable
!Name
!Description
|-
|LIMIT_MARGIN
|
|-
|INDICATORS
|
|}
==Api Model Scope==
API Enumeration description of Scope
{|class=wikitable
!Name
!Description
|-
|MAP
|
|-
|WATER_AREAS
|
|-
|LIMIT_AREAS
|
|-
|OVERRIDE_RAIN_AREAS
|
|}
==Api Model Section==
API Model description of Section
{|class=wikitable
!Name
!Type
!Description
|-
|floors
|int
|
|-
|id
|int
|
|-
|outerLines
|MultiLineString
|
|-
|polygons
|MultiPolygon
|
|-
|roofHeightM
|double
|
|-
|roofPolygons
|GeometryCollection
|
|-
|roofShape
|float[]
|
|-
|skeletonEnd
|Point
|
|-
|skeletonLines
|MultiLineString
|
|-
|skeletonStart
|Point
|
|-
|slantingRoofHeightM
|double
|
|}
==Api Model ServiceOverlay==
API Model description of ServiceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ServiceSource==
API Model description of ServiceSource
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|date
|long
|
|-
|description
|String
|
|-
|format
|GeoFormat
|
|-
|id
|int
|
|-
|infoUrl
|String
|
|-
|name
|String
|
|-
|uploaderName
|String
|
|-
|url
|String
|
|-
|version
|int
|
|}
==Api Model ShadowAttribute==
API Enumeration description of ShadowAttribute
{|class=wikitable
!Name
!Description
|-
|DATES
|
|-
|SUN_ALTITUDE
|
|-
|SUN_AZIMUTH
|
|-
|MAX_SHADOW_DISTANCE
|
|-
|MAX_FOLIAGE_RADIUS
|
|}
==Api Model ShadowOverlay==
API Model description of ShadowOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model ShadowPrequel==
API Enumeration description of ShadowPrequel
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|-
|BUILDING_ELEVATION
|
|-
|TERRAIN_ELEVATION
|
|}
==Api Model ShadowResult==
API Enumeration description of ShadowResult
{|class=wikitable
!Name
!Description
|-
|SHADE
|
|-
|FOLIAGE
|
|}
==Api Model Shoreline==
API Enumeration description of Shoreline
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|ONE_CELL
|
|-
|TWO_CELLS
|
|}
==Api Model Show==
API Enumeration description of Show
{|class=wikitable
!Name
!Description
|-
|FAR
|
|-
|MIDDLE
|
|-
|CLOSE
|
|}
==Api Model SightDistanceAttribute==
API Enumeration description of SightDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|SOURCE_HEIGHT_M
|
|-
|OBSERVER_HEIGHT_M
|
|-
|ATTRIBUTE_TIMEFRAMES
|
|}
==Api Model SourceOverlay==
API Model description of SourceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|restColor
|TColor
|
|-
|sortIndex
|int
|
|-
|sources
|Map&lt;int,int&gt;
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model SpecialEffect==
API Model description of SpecialEffect
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|id
|int
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|point
|Point
|
|-
|version
|int
|
|}
==Api Model SpecialOption==
API Model description of SpecialOption
{|class=wikitable
!Name
!Type
!Description
|-
|defaults
|Type<nowiki>[]</nowiki>
|
|-
|description
|String
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model Stakeholder==
API Model description of Stakeholder
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|client
|ClientData
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|lastSelected
|long
|
|-
|name
|String
|
|-
|shortName
|String
|
|-
|startBudget
|double
|
|-
|startBudgets
|Map&lt;int,double&gt;
|
|-
|startCinematics
|Map&lt;int,int&gt;
|
|-
|startPoint
|Point
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|webToken
|String
|
|}
==Api Model Style==
API Enumeration description of Style
{|class=wikitable
!Name
!Description
|-
|INTERPOLATED
|
|-
|NEAREST
|
|-
|ARROW
|
|-
|COLOR
|
|-
|FLOAT32
|
|-
|DIFFERENCE
|
|}
==Api Model SubsidenceAttribute==
API Enumeration description of SubsidenceAttribute
{|class=wikitable
!Name
!Description
|-
|YEARS
|
|-
|YEARS_PER_TIMEFRAME
|
|-
|START_YEAR
|
|-
|A
|
|-
|B
|
|-
|C
|
|-
|ACTIVE_DRAINAGE_FACTOR
|
|-
|PASSIVE_DRAINAGE_FACTOR
|
|-
|CLIMATE_START_TEMP
|
|-
|CLIMATE_FINAL_TEMP
|
|-
|CLIMATE_START_YEAR
|
|-
|CLIMATE_FINAL_YEAR
|
|-
|CLIMATE_OXIDATION
|
|-
|CLIMATE_SOIL_TEMP_FACTOR
|
|-
|LOW_PASSIVE_DRAINAGE
|
|-
|HI_PASSIVE_DRAINAGE
|
|-
|DEFAULT_PEAT_FRACTION
|
|-
|DEFAULT_TOP_LAYER_THICKNESS
|
|-
|DEFAULT_CLAY_THICKNESS
|
|-
|INUNDATE_LAND_BELOW_WATER_LEVEL
|
|}
==Api Model SubsidenceKey==
API Enumeration description of SubsidenceKey
{|class=wikitable
!Name
!Description
|-
|WATER_LEVEL
|
|-
|WATER_LEVEL_OUTPUT
|
|-
|CLAY_THICKNESS
|
|-
|INDEXATION
|
|-
|PEAT_FRACTION
|
|-
|TOPLAYER_THICKNESS
|
|-
|SUBSIDENCE
|
|-
|DRAINAGE
|
|-
|HI_GROUND_WATER_LEVEL
|
|-
|LOW_GROUND_WATER_LEVEL
|
|}
==Api Model SubsidenceOverlay==
API Model description of SubsidenceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model SubsidencePrequel==
API Enumeration description of SubsidencePrequel
{|class=wikitable
!Name
!Description
|-
|LOW_GROUND_WATER
|
|-
|HIGH_GROUND_WATER
|
|-
|CLAY_THICKNESS
|
|}
==Api Model SubsidenceResult==
API Enumeration description of SubsidenceResult
{|class=wikitable
!Name
!Description
|-
|SUBSIDENCE
|
|-
|OXIDATION
|
|-
|SETTLEMENT
|
|-
|LOW_GROUND_WATER
|
|-
|HI_GROUND_WATER
|
|}
==Api Model SurfaceMode==
API Enumeration description of SurfaceMode
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|SHALLOW
|
|-
|AVG_WATERWAY
|
|-
|HYBRID
|
|-
|AVG_TERRAIN
|
|}
==Api Model TColor==
API Model description of TColor
{|class=wikitable
!Name
!Type
!Description
|}
==Api Model TemplateExcelPanel==
API Model description of TemplateExcelPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|autoApplied
|boolean
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|relation
|Relation
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|useOwner
|boolean
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model TemplateTextPanel==
API Model description of TemplateTextPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attribute
|String
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|autoApplied
|boolean
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|mapLink
|MapLink
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|relation
|Relation
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|useOwner
|boolean
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model Tensor==
API Model description of Tensor
{|class=wikitable
!Name
!Type
!Description
|-
|dimensions
|int[]
|
|-
|input
|boolean
|
|-
|name
|String
|
|-
|normalize
|boolean
|
|-
|type
|DataType
|
|}
==Api Model TensorLink==
API Model description of TensorLink
{|class=wikitable
!Name
!Type
!Description
|-
|coordinate
|int[]
|
|-
|id
|int
|
|-
|normalized
|boolean
|
|-
|prequel
|String
|
|-
|result
|String
|
|-
|tensorName
|String
|
|-
|valueType
|ValueType
|
|}
==Api Model Terrain==
API Model description of Terrain
{|class=wikitable
!Name
!Type
!Description
|-
|current
|MultiPolygon
|
|-
|heightValuesCurrent
|double[]
|
|-
|heightValuesMaquette
|double[]
|
|-
|id
|int
|
|-
|maquette
|MultiPolygon
|
|-
|name
|String
|
|-
|showSatellite
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|typeID
|int
|[[Terrain Type]] ID
|-
|version
|int
|
|}
==Api Model TerrainAttribute==
API Enumeration description of TerrainAttribute
{|class=wikitable
!Name
!Description
|-
|ANGLE_OF_REPOSE
|
|-
|WATER_DEPTH_M
|
|-
|BOWEN_RATIO
|
|-
|BUILDABLE
|
|-
|SUBSIDENCE
|
|-
|COLOR
|
|-
|HEAT_EFFECT
|
|-
|LIVABILITY_EFFECT
|
|-
|TERRAIN_MIX
|
|-
|TEXTURE_TYPE
|
|-
|WATER
|
|-
|GROUND_INFILTRATION_MD
|
|-
|HYDRAULIC_CONDUCTIVITY_MD
|
|-
|HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS_MD
|
|-
|VAN_GENUCHTEN_M
|
|-
|ROOT_DEPTH_M
|
|-
|VEGETATION_FRACTION
|
|-
|WATER_STORAGE_PERCENTAGE
|
|-
|WATER_MANNING
|
|-
|WATER_MICRORELIEF_M
|
|-
|WATER_TRANSPIRATION_FACTOR
|
|}
==Api Model TerrainFeature==
API Model description of TerrainFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|this$0
|TerrainSpatial
|
|-
|version
|int
|
|}
==Api Model TerrainSpatial==
API Model description of TerrainSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|innerHeight
|double
|
|-
|innerPolygon
|MultiPolygon
|
|-
|innerPrep
|PreparedGeometry
|
|-
|measureEditType
|MeasureEditType
|
|-
|outerPolygon
|MultiPolygon
|
|-
|outerPrep
|PreparedGeometry
|
|-
|outerRings
|LineString<nowiki>[]</nowiki>
|
|-
|relative
|boolean
|
|-
|terrainTypeID
|int
|
|}
==Api Model TerrainType==
API Model description of TerrainType
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|code
|String
|
|-
|groundLayerType
|Layer
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Terrain Type]] ID
|-
|version
|int
|
|}
==Api Model TextPanel==
API Model description of TextPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|contentID
|int
|
|-
|contentMapLink
|MapLink
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|parentID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|text
|String
|
|-
|type
|PanelType
|
|-
|updateTiming
|Timing
|
|-
|version
|int
|
|-
|warnings
|String
|
|-
|width
|double
|
|}
==Api Model TimeState==
API Enumeration description of TimeState
{|class=wikitable
!Name
!Description
|-
|NOTHING
|
|-
|WAITING_FOR_DATE
|
|-
|REQUEST_PLOT_OWNER_APPROVAL
|
|-
|REQUEST_ZONING_APPROVAL
|
|-
|REQUEST_CONSTRUCTION_APPROVAL
|
|-
|CONSTRUCTION_APPROVED
|
|-
|CONSTRUCTION_DENIED
|
|-
|PENDING_CONSTRUCTION
|
|-
|CONSTRUCTING
|
|-
|READY
|
|-
|PENDING_UPGRADE
|
|-
|WAITING_FOR_DEMOLISH_DATE
|
|-
|REQUEST_DEMOLISH_ZONING_APPROVAL
|
|-
|REQUEST_DEMOLISH_APPROVAL
|
|-
|DEMOLISH_APPROVED
|
|-
|DEMOLISH_DENIED
|
|-
|PENDING_DEMOLISHING
|
|-
|DEMOLISHING
|
|-
|DEMOLISH_FINISHED
|
|}
==Api Model Timing==
API Enumeration description of Timing
{|class=wikitable
!Name
!Description
|-
|BEFORE
|
|-
|AFTER
|
|}
==Api Model TrafficAttribute==
API Enumeration description of TrafficAttribute
{|class=wikitable
!Name
!Description
|-
|HOURS
|
|-
|CARS_ACTIVE
|
|-
|VANS_ACTIVE
|
|-
|TRUCKS_ACTIVE
|
|-
|BUSES_ACTIVE
|
|}
==Api Model TrafficDensityOverlay==
API Model description of TrafficDensityOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model TrafficNO2Attribute==
API Enumeration description of TrafficNO2Attribute
{|class=wikitable
!Name
!Description
|-
|BASE_O3
|
|-
|BASE_NO2
|
|-
|EMISSION_CAR_NOX
|
|-
|EMISSION_CAR_NO2
|
|-
|EMISSION_JAM_CAR_NOX
|
|-
|EMISSION_JAM_CAR_NO2
|
|-
|EMISSION_VAN_NOX
|
|-
|EMISSION_VAN_NO2
|
|-
|EMISSION_JAM_VAN_NOX
|
|-
|EMISSION_JAM_VAN_NO2
|
|-
|EMISSION_TRUCK_NOX
|
|-
|EMISSION_TRUCK_NO2
|
|-
|EMISSION_JAM_TRUCK_NOX
|
|-
|EMISSION_JAM_TRUCK_NO2
|
|-
|EMISSION_BUS_NOX
|
|-
|EMISSION_BUS_NO2
|
|-
|EMISSION_JAM_BUS_NOX
|
|-
|EMISSION_JAM_BUS_NO2
|
|-
|ROAD1_30M_A
|
|-
|ROAD1_30M_B
|
|-
|ROAD1_30M_C
|
|-
|ROAD1_60M_ALPHA
|
|-
|ROAD1_60M_POWER
|
|-
|MIN_TREE_HEIGHT_M
|
|}
==Api Model TrafficNoiseAttribute==
API Enumeration description of TrafficNoiseAttribute
{|class=wikitable
!Name
!Description
|-
|BACKGROUND_DB
|
|-
|V0_CAR
|
|-
|V0_VAN
|
|-
|V0_TRUCK
|
|-
|V0_BUS
|
|-
|EMISSION_START_CAR
|
|-
|EMISSION_START_VAN
|
|-
|EMISSION_START_TRUCK
|
|-
|EMISSION_START_BUS
|
|-
|EMISSION_MULT_CAR
|
|-
|EMISSION_MULT_VAN
|
|-
|EMISSION_MULT_TRUCK
|
|-
|EMISSION_MULT_BUS
|
|}
==Api Model TrafficOverlay==
API Model description of TrafficOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model TrafficType==
API Enumeration description of TrafficType
{|class=wikitable
!Name
!Description
|-
|CAR
|
|-
|VAN
|
|-
|TRUCK
|
|-
|BUS
|
|-
|BICYCLE
|
|-
|PEDESTRIAN
|
|-
|SHIP
|
|-
|TRAM
|
|-
|TRAIN
|
|-
|AIR
|
|}
==Api Model TravelDistanceAttribute==
API Enumeration description of TravelDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|MAX_TRAVEL_DISTANCE
|
|-
|ROAD_DISTANCE
|
|-
|ROUTE_PEDESTRIANS
|
|-
|ROUTE_BICYCLES
|
|-
|ROUTE_CARS
|
|-
|ROUTE_TRUCKS
|
|-
|ROUTE_TRAMS
|
|-
|ROUTE_TRAINS
|
|-
|ROUTE_SHIPS
|
|-
|DESTINATION_THRESHOLD
|
|-
|BLOCKING_THRESHOLD
|
|-
|TRAVERSABLE_THRESHOLD
|
|}
==Api Model TravelDistanceKey==
API Enumeration description of TravelDistanceKey
{|class=wikitable
!Name
!Description
|-
|DESTINATION_AREA
|
|-
|BLOCKED
|
|}
==Api Model TravelDistanceOverlay==
API Model description of TravelDistanceOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model TravelDistancePrequel==
API Enumeration description of TravelDistancePrequel
{|class=wikitable
!Name
!Description
|-
|TRAVERSABLE
|
|-
|BLOCKING
|
|-
|DESTINATION
|
|}
==Api Model TravelDistanceResult==
API Enumeration description of TravelDistanceResult
{|class=wikitable
!Name
!Description
|-
|DESTINATIONS
|
|-
|BASE_TYPES
|
|}
==Api Model Trigger==
API Model description of Trigger
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|calcTimeMS
|long
|
|-
|id
|int
|
|-
|method
|Method
|
|-
|name
|String
|
|-
|timeoutMS
|int
|
|-
|timing
|Timing
|
|-
|type
|Type
|
|-
|url
|String
|
|-
|version
|int
|
|-
|warnings
|String
|
|}
==Api Model Type (PopupData)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|STAKEHOLDER_STANDARD
|
|-
|INTERACTION
|
|-
|INTERACTION_WITH_DATE
|
|-
|INFORMATION
|
|-
|LABEL
|
|}
==Api Model Type (SpecialOption)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|BUY_LAND
|
|-
|SELL_LAND
|
|-
|DEMOLISH
|
|-
|REVERT
|
|-
|DEMOLISH_UNDERGROUND
|
|-
|RAISE_LAND
|
|-
|SHOW_BUDGETPANEL
|
|-
|SHOW_MONEY_TRANSFER_PANEL
|
|-
|LOWER_LAND
|
|}
==Api Model Type (Stakeholder)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|CIVILIAN
|
|-
|COMPANY
|
|-
|EDUCATION
|
|-
|EXPERT
|
|-
|FARMER
|
|-
|HEALTHCARE
|
|-
|HOUSING_CORPORATION
|
|-
|MUNICIPALITY
|
|-
|MEDIA
|
|-
|PROJECT_DEVELOPER
|
|-
|UTILITY_CORPORATION
|
|-
|WATER_AUTHORITY
|
|-
|OTHER_AUTHORITY
|
|-
|OTHER
|
|}
==Api Model Type (Trigger)==
API Enumeration description of Type
{|class=wikitable
!Name
!Description
|-
|TQL
|
|-
|EVENT
|
|}
==Api Model UniqueNamedItem==
API Model description of UniqueNamedItem
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model UnitData==
API Model description of UnitData
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|colors
|TColor<nowiki>[]</nowiki>
|
|-
|fileName
|String
|
|-
|id
|int
|
|-
|isAlpha
|boolean
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|proximityWarningM
|double
|
|-
|regions
|Region<nowiki>[]</nowiki>
|
|-
|type
|TrafficType
|
|-
|version
|int
|
|}
==Api Model UnitDataOverride==
API Model description of UnitDataOverride
{|class=wikitable
!Name
!Type
!Description
|-
|active
|Boolean
|
|-
|colors
|TColor<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|name
|String
|
|-
|version
|int
|
|}
==Api Model UpgradeFeature==
API Model description of UpgradeFeature
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|version
|int
|
|}
==Api Model UpgradeSpatial==
API Model description of UpgradeSpatial
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|multiPolygon
|MultiPolygon
|
|-
|upgradeID
|int
|[[Upgrade Type]] ID
|}
==Api Model ValueType==
API Enumeration description of ValueType
{|class=wikitable
!Name
!Description
|-
|DEFAULT
|
|-
|R
|
|-
|G
|
|-
|B
|
|-
|A
|
|}
==Api Model WCSOverlay==
API Model description of WCSOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WCSResult==
API Enumeration description of WCSResult
{|class=wikitable
!Name
!Description
|-
|NEAREST
|
|-
|INTERPOLATED
|
|}
==Api Model WMSOverlay==
API Model description of WMSOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|crs
|String
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|forceXY
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|layerName
|String
|
|-
|layerNames
|String<nowiki>[]</nowiki>
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|sourceID
|int
|[[Source]] ID
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WMSResult==
API Enumeration description of WMSResult
{|class=wikitable
!Name
!Description
|-
|COLOR
|
|-
|FLOAT32
|
|-
|RED
|
|-
|GREEN
|
|-
|BLUE
|
|-
|ALPHA
|
|}
==Api Model WWOverlay==
API Model description of WWOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
==Api Model WaterKey==
API Enumeration description of WaterKey
{|class=wikitable
!Name
!Description
|-
|WATER_LEVEL
|
|-
|WATER_RELATIVE
|
|-
|INLET_Q
|
|-
|INLET_CAPACITY
|
|-
|INLET_AREA
|
|-
|LOWER_THRESHOLD
|
|-
|UPPER_THRESHOLD
|
|-
|UNDERGROUND
|
|-
|INUNDATION_LEVEL
|
|-
|AQUIFER_KD
|
|-
|AQUIFER_DATUM
|
|-
|SEWER_STORAGE
|
|-
|SEWER_PUMP_SPEED
|
|-
|WEIR_HEIGHT
|
|-
|WEIR_WIDTH
|
|-
|WEIR_COEFFICIENT
|
|-
|WEIR_N
|
|-
|WEIR_ANGLE
|
|-
|WEIR_TARGET_LEVEL
|
|-
|CULVERT_DIAMETER
|
|-
|CULVERT_N
|
|-
|CULVERT_THRESHOLD
|
|-
|CULVERT_RECTANGULAR_HEIGHT
|
|-
|PUMP_Q
|
|-
|PUMP_ANGLE
|
|-
|PUMP_AREA
|
|-
|DRAINAGE_Q
|
|-
|DRAINAGE_DATUM
|
|-
|DRAINAGE_OVERFLOW_THRESHOLD
|
|-
|DRAINAGE_ACTIVE
|
|-
|BREACH_SPEED
|
|-
|BREACH_HEIGHT
|
|-
|BREACH_WIDTH
|
|-
|BREACH_ANGLE
|
|-
|BREACH_COEFFICIENT
|
|-
|BREACH_INPUT_AREA
|
|-
|BREACH_LEVEL_AREA
|
|-
|EXTERNAL_SURFACE_LEVEL
|
|-
|EXTERNAL_WATER_LEVEL
|
|-
|EXTERNAL_AREA
|
|-
|SEWER_OVERFLOW
|
|-
|SEWER_OVERFLOW_SPEED
|
|-
|OBJECT_FLOW_OUTPUT
|
|-
|OBJECT_DATUM_OUTPUT_A
|
|-
|OBJECT_DATUM_OUTPUT_B
|
|-
|OBJECT_WIDTH_OUTPUT
|
|-
|OBJECT_HEIGHT_OUTPUT
|
|-
|OBJECT_WATER_AREA_OUTPUT
|
|-
|WEIR_DAM_OUTPUT
|
|-
|TRACER_A
|
|-
|TRACER_B
|
|-
|TRACER_C
|
|-
|TRACER_D
|
|-
|LIMIT_AREA
|
|-
|RAIN_M
|
|}
==Api Model WaterModelAttribute==
API Enumeration description of WaterModelAttribute
{|class=wikitable
!Name
!Description
|-
|ALLOWED_WATER_INCREASE_M
|
|-
|GROUND_WATERTABLE_WITH_SURFACE
|
|-
|DESIGN_FLOOD_ELEVATION_M
|
|-
|GROUND_BOTTOM_DISTANCE_M
|
|-
|GROUND_BOTTOM_PRESSURE_M
|
|-
|GROUND_WATER
|
|-
|GROUND_WATER_DEPTH_M
|
|-
|HYDRAULIC_CONDUCTIVITY_WITH_THICKNESS
|
|-
|SOIL_WATER_RETENTION_CURVE
|
|-
|UNSATURATED_FRACTION
|
|-
|IMPACT_FLOOD_THRESHOLD_M
|
|-
|IMPACT_RANGE_M
|
|-
|CULVERT_DEM_THRESHOLD_M
|
|-
|QCELL
|
|-
|INCREASED_RESOLUTION
|
|-
|SHORELINE
|
|-
|OBJECT_ENTRY_CORRECTION
|
|-
|SEWER_OVERFLOW_THRESHOLD
|
|-
|DURATION_MIN_LEVEL_M
|
|-
|RISE_RATE_DISTANCE_M
|
|-
|SURFACE_WATER_EVAPORATION_FACTOR
|
|-
|TIMEFRAMES
|
|-
|TIMEFRAME_TIMES
|
|-
|LIMIT_AREA
|
|-
|LIMIT_RAIN
|
|-
|MAX_WATER_BOTTOM_M
|
|-
|START_DATE_MS
|
|-
|AVG_SHORE_WIDTH_M
|
|-
|AVG_TERRAIN_WIDTH_M
|
|-
|AVG_TERRAIN_STORAGE_M
|
|-
|SURFACE_WATER
|
|-
|PREQUEL_SURFACE_LEVEL_RELATIVE
|
|-
|MICRORELIEF_STORAGE_FRACTION
|
|-
|MIN_MAX_ELEVATION
|
|-
|BRIDGE_ELEVATION
|
|-
|MAX_INFILTRATION_M
|
|-
|MIN_DRAIN_SURFACE_DISTANCE_M
|
|-
|INFILTRATION_FACTOR_S
|
|-
|WEIR_DAM_MULTIPLIER
|
|-
|WEIR_DAM_SURPLUS_HEIGHT_M
|
|-
|BREACH_MEASUREMENT_DISTANCE_M
|
|-
|STABILIZER_ANGLE
|
|-
|WEIR_MOVE_INTERVAL_S
|
|-
|WEIR_MOVE_STEP_M
|
|-
|WEIR_MOVE_RANGE_M
|
|-
|PARTIAL_START_SEC
|
|-
|PARTIAL_END_SEC
|
|-
|TRIM_MANNING
|
|-
|TRIM_EVAPOTRANSPIRATION
|
|-
|TRIM_ROOT_DEPTH
|
|-
|TRIM_GROUND_INFILTRATION
|
|-
|TRIM_GROUND_CONDUCTIVITY
|
|-
|TRIM_SHORELINE_CONDUCTIVITY
|
|-
|TRIM_GROUND_STORAGE_FRACTION
|
|}
==Api Model WaterOverlay==
API Model description of WaterOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|minValue
|float[]
|
|-
|mode
|Mode
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showAreas
|boolean
|
|-
|showDifference
|boolean
|
|-
|showSystem
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
==Api Model WaterPrequel==
API Enumeration description of WaterPrequel
{|class=wikitable
!Name
!Description
|-
|TERRAIN_ELEVATION
|
|-
|SURFACE_LEVEL
|
|-
|SURFACE_U
|
|-
|SURFACE_V
|
|-
|SURFACE_INFILTRATION
|
|-
|GROUND_WATER_DEPTH
|
|-
|GROUND_WATER_DATUM
|
|-
|GROUND_CONDUCTIVITY
|
|-
|GROUND_INFILTRATION
|
|-
|GROUND_STORAGE_FRACTION
|
|-
|UNSATURATED_FRACTION
|
|-
|BOTTOM_DISTANCE
|
|-
|BOTTOM_RESISTANCE
|
|-
|BOTTOM_PRESSURE
|
|-
|MAX_INFILTRATION
|
|-
|MANNING
|
|-
|MICRORELIEF
|
|-
|SEWER_LEVEL
|
|}
==Api Model WaterResult==
API Enumeration description of WaterResult
{|class=wikitable
!Name
!Description
|-
|WATER_STRESS
|
|-
|SURFACE_LAST_DIRECTION
|
|-
|SURFACE_AVG_DIRECTION
|
|-
|SURFACE_DURATION
|
|-
|SURFACE_ELEVATION
|
|-
|SURFACE_FLOW
|
|-
|SURFACE_LAST_FLOW
|
|-
|SURFACE_LAST_SPEED
|
|-
|SURFACE_LAST_VALUE
|
|-
|SURFACE_LAST_DATUM
|
|-
|SURFACE_MAX_SPEED
|
|-
|SURFACE_MAX_VALUE
|
|-
|SURFACE_EVAPORATION
|
|-
|SURFACE_LAST_EVAPORATION
|
|-
|BUILDING_LAST_STORAGE
|
|-
|FLOOD_ARRIVAL_TIME
|
|-
|FLOOD_RISE_RATE
|
|-
|LAST_RAIN
|
|-
|RAIN
|
|-
|GROUND_LAST_STORAGE
|
|-
|GROUND_LAST_VALUE
|
|-
|GROUND_LAST_DIRECTION
|
|-
|GROUND_FLOW
|
|-
|GROUND_MAX_STORAGE
|
|-
|GROUND_MAX_VALUE
|
|-
|GROUND_WATERTABLE
|
|-
|GROUND_BOTTOM_FLOW
|
|-
|GROUND_LAST_UNSATURATED_STORAGE
|
|-
|GROUND_LAST_UNSATURATED_FRACTION
|
|-
|GROUND_TRANSPIRATION
|
|-
|GROUND_LAST_TRANSPIRATION
|
|-
|SEWER_LAST_VALUE
|
|-
|SEWER_MAX_VALUE
|
|-
|LAST_EVAPORATED
|
|-
|LAST_EVAPOTRANSPIRATION
|
|-
|EVAPORATED
|
|-
|EVAPOTRANSPIRATION
|
|-
|IMPACTED_BUILDINGS
|
|-
|TRACER_A
|
|-
|TRACER_B
|
|-
|TRACER_C
|
|-
|TRACER_D
|
|-
|BASE_TYPES
|
|-
|SURFACE_DIFFERENCE
|
|-
|DEBUG_UV
|
|-
|GPU_OVERVIEW
|
|-
|DEBUG_AVG_AREAS
|
|-
|DEBUG_UV_DIRECTION
|
|-
|DEBUG_WATERWAYS
|
|-
|SURFACE_LAST_U
|
|-
|SURFACE_LAST_V
|
|}
==Api Model WaterSystem==
API Enumeration description of WaterSystem
{|class=wikitable
!Name
!Description
|-
|OBJECTS
|
|-
|AREAS
|
|}
==Api Model WaterType==
API Enumeration description of WaterType
{|class=wikitable
!Name
!Description
|-
|NONE
|
|-
|WATERWAY
|
|-
|WATERBODY
|
|-
|SEA
|
|}
==Api Model WatershedKey==
API Enumeration description of WatershedKey
{|class=wikitable
!Name
!Description
|-
|DISCHARGE_AREA
|
|}
==Api Model WatershedModelAttribute==
API Enumeration description of WatershedModelAttribute
{|class=wikitable
!Name
!Description
|-
|FILL_DISTANCE
|
|-
|DISCHARGE_REMAINING_WATER
|
|-
|CULVERT_FLOW_DIRECTION
|
|-
|MIN_AREA
|
|-
|LIMIT_ROAD
|
|}
==Api Model WatershedOverlay==
API Model description of WatershedOverlay
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|diffLegend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|inActiveCellSize
|double
|
|-
|inActiveTimeframes
|int
|
|-
|keys
|Map&lt;String,String&gt;
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|maxValue
|float[]
|
|-
|method
|DischargeMethod
|
|-
|minValue
|float[]
|
|-
|name
|String
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|prequels
|Map&lt;String,PrequelLink&gt;
|
|-
|resultType
|String
|
|-
|showDifference
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
==Api Model WatershedPrequel==
API Enumeration description of WatershedPrequel
{|class=wikitable
!Name
!Description
|-
|DIRECTION
|
|}
==Api Model WatershedResult==
API Enumeration description of WatershedResult
{|class=wikitable
!Name
!Description
|-
|WATERSHEDS
|
|-
|DISCHARGE_AREAS
|
|-
|DIRECTION
|
|-
|BASE_TYPES
|
|}
==Api Model WebPanel==
API Model description of WebPanel
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|height
|double
|
|-
|id
|int
|
|-
|layoutX
|double
|
|-
|layoutY
|double
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|overlayID
|int
|[[Overlay]] ID
|-
|overrideDefaultAnswerID
|int
|
|-
|point
|Point
|
|-
|stakeholderID
|int
|[[Stakeholder]] ID
|-
|type
|PanelType
|
|-
|url
|String
|
|-
|version
|int
|
|-
|width
|double
|
|}
==Api Model ZipCode==
API Model description of ZipCode
{|class=wikitable
!Name
!Type
!Description
|-
|color
|TColor
|
|-
|id
|int
|
|-
|name
|String
|
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model Zone==
API Model description of Zone
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|center
|Point
|
|-
|excelID
|int
|[[Excel Sheet]] ID
|-
|excelUpdated
|boolean
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|outline
|Outline
|
|-
|parentZoneID
|int
|[[Zone]] ID
|-
|permitterID
|int
|[[Stakeholder]] ID
|-
|polygons
|MultiPolygon
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
==Api Model ZoneAttribute==
API Enumeration description of ZoneAttribute
{|class=wikitable
!Name
!Description
|-
|MAX_BUILDING_HEIGHT
|
|-
|MAX_ROOF_GUTTER_HEIGHT
|
|-
|MAX_FLOORS
|
|-
|MIN_FLOORS
|
|-
|AMOUNT_FLOORS
|
|-
|MAX_BUILDING_PCT
|
|-
|MONUMENTAL
|
|}
==Api Model ZoneDistanceAttribute==
API Enumeration description of ZoneDistanceAttribute
{|class=wikitable
!Name
!Description
|-
|ATTRIBUTE_TIMEFRAMES
|
|-
|HIT_COUNT
|
|
|}
|}
Line 12,878: Line 4,815:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 14:14, 24 April 2026

Api session items Overlay Endpoints.

Edit items with event: editoroverlay.

Default Query: 

https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "attributes" : {
    "FOO" : [ 1.0 ],
    "PINO" : [ 87.824625 ],
    "SINGLE" : [ 75.624039 ],
    "SJAAKIE" : [ 97.724805 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 0,
  "imageName" : "normal.png",
  "imageVersion" : 0,
  "legend" : [ ],
  "maquetteOverride" : null,
  "name" : "namx8",
  "parentID" : -1,
  "sortIndex" : 52,
  "type" : null,
  "version" : 1,
  "visible" : true
}, {
  "attributes" : {
    "PINO" : [ 1.0 ],
    "SJAAKIE" : [ 1.0 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 1,
  "imageName" : "neighborhoods.png",
  "imageVersion" : 0,
  "legend" : [ {
    "color" : {
      "argb" : -9772392
    },
    "entryName" : "buurt",
    "id" : 1,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -1877165
    },
    "entryName" : "Sonsbeek-Noord",
    "id" : 2,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -16173383
    },
    "entryName" : "Onder de Linden",
    "id" : 3,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -6740311
    },
    "entryName" : "St. Janskerkstraat e.o.",
    "id" : 4,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -15232895
    },
    "entryName" : "Hazegrietje",
    "id" : 5,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -4609484
    },
    "entryName" : "Klarenbeek",
    "id" : 6,
    "value" : "-Infinity"
  } ],
  "maquetteOverride" : null,
  "name" : "aOAcT",
  "parentID" : -1,
  "sortIndex" : 51,
  "type" : "NEIGHBORHOODS",
  "version" : 12,
  "visible" : true
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN

Show Queries

max version: 

https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN

size: 

https://engine.tygron.com/api/session/items/overlays/size/?token=API_TOKEN

Overlays (GeoJSON): 

https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/overlays/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/overlays/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/overlays/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/overlays/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN

Api Model AeriusOverlay

API Model description of AeriusOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
sortIndex int
type OverlayType
version int
visible boolean

Api Model AreaOverlay

API Model description of AreaOverlay

Name Type Description
areaIDs int[] Area ID
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
remainderColor TColor
sortIndex int
type OverlayType
version int
visible boolean

Api Model AttributeOverlay

API Model description of AttributeOverlay

Name Type Description
attribute String
attributeColor TColor
attributes Map<String,double[]>
colorAttribute String
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
mapLink MapLink
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
restColor TColor
sortIndex int
type OverlayType
version int
visible boolean

Api Model AvgOverlay

API Model description of AvgOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerMapLink MapLink
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
rasterization Rasterization
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ComboOverlay

API Model description of ComboOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
formula String
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerMapLink MapLink
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
rasterization Rasterization
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model DefaultOverlay

API Model description of DefaultOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model DefaultRasterizationOverlay

API Model description of DefaultRasterizationOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerMapLink MapLink
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
rasterization Rasterization
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model DischargeMethod

API Enumeration description of DischargeMethod

Name Description
HEIGHT_MINIMA
WATER_TERRAINS
AREAS

Api Model DistanceOverlay

API Model description of DistanceOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerMapLink MapLink
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
rasterization Rasterization
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model FloodingOverlay

API Model description of FloodingOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
mode Mode
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showAreas boolean
showDifference boolean
showSystem boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String
weatherID int Weather ID

Api Model FunctionOverlay

API Model description of FunctionOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
functionIDs int[] Function ID
functionsColor TColor
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
remainderColor TColor
sortIndex int
type OverlayType
version int
visible boolean

Api Model GeoTiffOverlay

API Model description of GeoTiffOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
geoTiffIDs int[] GeoTIFF ID
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model GridOverlay

API Model description of GridOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model GroundwaterOverlay

API Model description of GroundwaterOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
mode Mode
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showAreas boolean
showDifference boolean
showSystem boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String
weatherID int Weather ID

Api Model HeatModel

API Enumeration description of HeatModel

Name Description
UNESCO
DPRA

Api Model HeatOverlay

API Model description of HeatOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
model HeatModel
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model HeightOverlay

API Model description of HeightOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ImageOverlay

API Model description of ImageOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageNames String[]
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
sortIndex int
type OverlayType
version int
visible boolean

Api Model InferenceOverlay

API Model description of InferenceOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
neuralNetworkID int Neural Network ID
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
tensorLinks TensorLink[]
type OverlayType
version int
visible boolean
warnings String

Api Model IterationOverlay

API Model description of IterationOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model LegendEntry

API Model description of LegendEntry

Name Type Description
color TColor
entryName String
id int
value float

Api Model Mode

API Enumeration description of Mode

Name Description
SPEED
AVERAGE
ACCURACY

Api Model NO2Overlay

API Model description of NO2Overlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model NetOverlay

API Model description of NetOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
netType NetType
parentID int Overlay ID
showActive boolean
showNetwork boolean
sortIndex int
type OverlayType
version int
visible boolean

Api Model NetType

API Enumeration description of NetType

Name Description
ELECTRICITY
GAS
HEAT
INTERNET
SEWER

Api Model NoiseOverlay

API Model description of NoiseOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model Overlay

API Model description of Overlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
sortIndex int
type OverlayType
version int
visible boolean

Api Model OverlayType

API Enumeration description of OverlayType

Name Description
OWNERSHIP
OWNERSHIP_GRID
ZIP_CODES
ZONING
NEIGHBORHOODS
MUNICIPALITIES
SCENARIO
VACANCY
HEAT_STRESS
SHADOW
TRAFFIC_DENSITY
TRAFFIC_NO2
TRAFFIC_NOISE
LIVABILITY
AERIUS
RAINFALL
FLOODING
GROUNDWATER
WATERSHED
SUBSIDENCE
WATERWIJZER
AVG
COMBO
DISTANCE
SIGHT_DISTANCE
TRAVEL_DISTANCE
INFERENCE
ITERATION
GEO_TIFF
WMS
WCS
IMAGE
AREA
ATTRIBUTE
FUNCTION
SATELLITE
HEIGHTMAP
UNDERGROUND
SOURCE
NETWORK_OWNERSHIP
NETWORK_OVERVIEW
NETWORK_DISTANCE
RESULT_CHILD
TEST
DISTURBANCE_DISTANCE
SAFETY_DISTANCE
DEPRECATED

Api Model RainOverlay

API Model description of RainOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
mode Mode
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showAreas boolean
showDifference boolean
showSystem boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String
weatherID int Weather ID

Api Model Rasterization

API Enumeration description of Rasterization

Name Description
FIRST
MIN
MAX
SINGLE_LAYER
GRID

Api Model RasterizationOverlay

API Model description of RasterizationOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerMapLink MapLink
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
rasterization Rasterization
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ResultChildOverlay

API Model description of ResultChildOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ResultParentOverlay

API Model description of ResultParentOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model SatelliteOverlay

API Model description of SatelliteOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ServiceOverlay

API Model description of ServiceOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
crs String
customLegend boolean
diffLegend LegendEntry[]
forceXY boolean
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerName String
layerNames String[]
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
sourceID int Source ID
type OverlayType
version int
visible boolean
warnings String

Api Model ShadowOverlay

API Model description of ShadowOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model SourceOverlay

API Model description of SourceOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
restColor TColor
sortIndex int
sources Map<int,int>
type OverlayType
version int
visible boolean

Api Model SubsidenceOverlay

API Model description of SubsidenceOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model TColor

API Model description of TColor

Name Type Description

API Model description of TensorLink

Name Type Description
coordinate int[]
id int
normalized boolean
prequel String
result String
tensorName String
valueType ValueType

Api Model TrafficDensityOverlay

API Model description of TrafficDensityOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
sortIndex int
type OverlayType
version int
visible boolean

Api Model TrafficOverlay

API Model description of TrafficOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model TravelDistanceOverlay

API Model description of TravelDistanceOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

Api Model ValueType

API Enumeration description of ValueType

Name Description
DEFAULT
R
G
B
A

Api Model WCSOverlay

API Model description of WCSOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
crs String
customLegend boolean
diffLegend LegendEntry[]
forceXY boolean
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerName String
layerNames String[]
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
sourceID int Source ID
type OverlayType
version int
visible boolean
warnings String

Api Model WMSOverlay

API Model description of WMSOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
crs String
customLegend boolean
diffLegend LegendEntry[]
forceXY boolean
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
layerName String
layerNames String[]
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
sourceID int Source ID
type OverlayType
version int
visible boolean
warnings String

Api Model WWOverlay

API Model description of WWOverlay

Name Type Description
attributes Map<String,double[]>
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
sortIndex int
type OverlayType
version int
visible boolean

Api Model WaterOverlay

API Model description of WaterOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcInfo String
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
mode Mode
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showAreas boolean
showDifference boolean
showSystem boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String
weatherID int Weather ID

Api Model WatershedOverlay

API Model description of WatershedOverlay

Name Type Description
active boolean
attributes Map<String,double[]>
calcTimeMS long
colorMultiplier double
colorOffset int
customLegend boolean
diffLegend LegendEntry[]
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
method DischargeMethod
minValue float[]
name String
parentID int Overlay ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType
version int
visible boolean
warnings String

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_overlays&oldid=78812"