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, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(50 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Overlay]] Endpoints.
API Endpoint: /api/session/items/overlays/


Manipulate items with event: [[Api session event editor overlay|editoroverlay]].
Edit items with events described at [[Api session event editor overlay]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "active" : true,
  "attributes" : {
    "CALC_TIME_MS" : [ 0.0 ]
  },
  "calcTimeMS" : 13,
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "diffLegend" : [ ],
  "id" : 3,
  "imageName" : "heightmap.png",
  "imageVersion" : 0,
  "inActiveCellSize" : null,
  "inActiveTimeframes" : null,
  "keys" : { },
  "legend" : [ {
    "color" : {
      "argb" : -13696641
    },
    "entryName" : "32,1",
    "id" : 1,
    "value" : 32.122
  }, {
    "color" : {
      "argb" : -16312961
    },
    "entryName" : "34",
    "id" : 2,
    "value" : 33.987503
  }, {
    "color" : {
      "argb" : -15122305
    },
    "entryName" : "35,9",
    "id" : 3,
    "value" : 35.853
  }, {
    "color" : {
      "argb" : -14719873
    },
    "entryName" : "37,7",
    "id" : 4,
    "value" : 37.718502
  }, {
    "color" : {
      "argb" : -13794421
    },
    "entryName" : "39,6",
    "id" : 5,
    "value" : 39.584
  }, {
    "color" : {
      "argb" : -12934235
    },
    "entryName" : "41,4",
    "id" : 6,
    "value" : 41.4495
  }, {
    "color" : {
      "argb" : -13467809
    },
    "entryName" : "43,3",
    "id" : 7,
    "value" : 43.315002
  }, {
    "color" : {
      "argb" : -10641847
    },
    "entryName" : "45,2",
    "id" : 8,
    "value" : 45.1805
  }, {
    "color" : {
      "argb" : -6169541
    },
    "entryName" : "47",
    "id" : 9,
    "value" : 47.046
  }, {
    "color" : {
      "argb" : -6437109
    },
    "entryName" : "48,9",
    "id" : 10,
    "value" : 48.9115
  }, {
    "color" : {
      "argb" : -4013540
    },
    "entryName" : "50,8",
    "id" : 11,
    "value" : 50.777
  }, {
    "color" : {
      "argb" : -2367897
    },
    "entryName" : "52,6",
    "id" : 12,
    "value" : 52.6425
  }, {
    "color" : {
      "argb" : -3366313
    },
    "entryName" : "54,5",
    "id" : 13,
    "value" : 54.508
  }, {
    "color" : {
      "argb" : -1530502
    },
    "entryName" : "56,4",
    "id" : 14,
    "value" : 56.3735
  }, {
    "color" : {
      "argb" : -2199968
    },
    "entryName" : "58,2",
    "id" : 15,
    "value" : 58.239
  }, {
    "color" : {
      "argb" : -2148303
    },
    "entryName" : "60,1",
    "id" : 16,
    "value" : 60.1045
  }, {
    "color" : {
      "argb" : -7467510
    },
    "entryName" : "62",
    "id" : 17,
    "value" : 61.97
  }, {
    "color" : {
      "argb" : -9493727
    },
    "entryName" : "63,8",
    "id" : 18,
    "value" : 63.8355
  }, {
    "color" : {
      "argb" : -9481646
    },
    "entryName" : "65,7",
    "id" : 19,
    "value" : 65.701
  }, {
    "color" : {
      "argb" : -3947581
    },
    "entryName" : "67,6",
    "id" : 20,
    "value" : 67.5665
  } ],
  "maquetteOverride" : null,
  "maxValue" : [ 0.0, 69.432, 0.0, 1.0 ],
  "minValue" : [ 0.0, 32.122, 0.0, 0.0 ],
  "name" : "Height Map",
  "parentID" : -1,
  "prequels" : { },
  "resultType" : "DSM",
  "showDifference" : false,
  "sortIndex" : 50,
  "type" : "HEIGHTMAP",
  "version" : 63,
  "visible" : true,
  "warnings" : ""
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/overlays/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/count/?token=API_TOKEN</syntaxhighlight>
Overlays (GeoJSON):
<pre>https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN</pre>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model AreaOverlay==
API Model description of AreaOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
| areaIDs
| int<nowiki>[]</nowiki>
| [[Area]]s ID
|-
| 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
|-
| remainderColor
| TColor
| [[Color]]
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model AttributeOverlay==
API Model description of AttributeOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
| attribute
| String
|
|-
| attributeColor
| TColor
| [[Color]]
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| colorAttribute
| String
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageVersion
| int
|
|-
| legend
| LegendEntry<nowiki>[]</nowiki>
|
|-
| mapLink
| MapLink
| [[Maplink]]
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| restColor
| TColor
| [[Color]]
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model AvgOverlay==
API Model description of AvgOverlay
 
{|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
| [[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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model ComboOverlay==
API Model description of ComboOverlay
 
{|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>
|
|-
| formula
| String
|
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageVersion
| int
|
|-
| inActiveCellSize
| double
|
|-
| inActiveTimeframes
| int
|
|-
| keys
| Map&lt;String,String&gt;
|
|-
| layerMapLink
| MapLink
| [[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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model DefaultOverlay==
API Model description of DefaultOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model DefaultRasterizationOverlay==
API Model description of DefaultRasterizationOverlay
 
{|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
| [[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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model DischargeMethod==
API Enumeration description of DischargeMethod
 
{|class=wikitable
!Name
!Description
|-
| HEIGHT_MINIMA
|
|-
| WATER_TERRAINS
|
|-
| AREAS
|
|}
 
==Api Model DistanceOverlay==
API Model description of DistanceOverlay
 
{|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
| [[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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model FloodingOverlay==
API Model description of FloodingOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|-
| weatherID
| int
| [[Weather]] ID
|}
 
==Api Model FunctionOverlay==
API Model description of FunctionOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|
|-
| functionIDs
| int<nowiki>[]</nowiki>
| [[Function]]s ID
|-
| functionsColor
| TColor
| [[Color]]
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageVersion
| int
|
|-
| legend
| LegendEntry<nowiki>[]</nowiki>
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| remainderColor
| TColor
| [[Color]]
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model GeoTiffOverlay==
API Model description of GeoTiffOverlay
 
{|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>
|
|-
| geoTiffIDs
| int<nowiki>[]</nowiki>
| [[GeoTIFF|Geo Tiffs]] 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
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| prequels
| Map&lt;String,PrequelLink&gt;
|
|-
| resultType
| String
|
|-
| showDifference
| boolean
|
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model GridOverlay==
API Model description of GridOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model GroundwaterOverlay==
API Model description of GroundwaterOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|-
| weatherID
| int
| [[Weather]] ID
|}
 
==Api Model HeatModel==
API Enumeration description of HeatModel
 
{|class=wikitable
!Name
!Description
|-
| UNESCO
|
|-
| DPRA
|
|}
 
==Api Model HeatOverlay==
API Model description of HeatOverlay
 
{|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[]
|
|-
| model
| HeatModel
|
|-
| name
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| prequels
| Map&lt;String,PrequelLink&gt;
|
|-
| resultType
| String
|
|-
| showDifference
| boolean
|
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model HeightOverlay==
API Model description of HeightOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model ImageOverlay==
API Model description of ImageOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageNames
| String<nowiki>[]</nowiki>
|
|-
| imageVersion
| int
|
|-
| legend
| LegendEntry<nowiki>[]</nowiki>
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model InferenceOverlay==
API Model description of InferenceOverlay
 
{|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
|
|-
| neuralNetworkID
| int
| [[Neural Network]] ID
|-
| parentID
| int
| [[Overlay]] ID
|-
| prequels
| Map&lt;String,PrequelLink&gt;
|
|-
| resultType
| String
|
|-
| showDifference
| boolean
|
|-
| sortIndex
| int
|
|-
| tensorLinks
| TensorLink<nowiki>[]</nowiki>
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model IterationOverlay==
API Model description of IterationOverlay
 
{|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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==Api Model LegendEntry==
API Model description of LegendEntry
 
{|class=wikitable
!Name
!Type
!Description
|-
| color
| TColor
| [[Color]]
|-
| entryName
| String
|
|-
| id
| int
|
|-
| value
| float
|
|}
 
==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
|
|-
| 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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Net Type]]
|-
| parentID
| int
| [[Overlay]] ID
|-
| showActive
| boolean
|
|-
| showNetwork
| boolean
|
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model NetType==
API Enumeration description of NetType
 
{|class=wikitable
!Name
!Description
|-
| ELECTRICITY
|
|-
| GAS
|
|-
| HEAT
|
|-
| INTERNET
|
|-
| SEWER
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==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 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
| [[Overlay Type]]
|-
| 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 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
| [[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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| 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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Color]]
|-
| sortIndex
| int
|
|-
| sources
| Map&lt;int,int&gt;
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==Api Model TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==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 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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|-
| weatherID
| int
| [[Weather]] ID
|}
 
==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
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor overlay]]
}}


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

Latest revision as of 10:01, 13 July 2026

API Endpoint: /api/session/items/overlays/

Edit items with events described at Api session event editor overlay.

Default Query: 

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

Example Response: 

[ {
  "active" : true,
  "attributes" : {
    "CALC_TIME_MS" : [ 0.0 ]
  },
  "calcTimeMS" : 13,
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "diffLegend" : [ ],
  "id" : 3,
  "imageName" : "heightmap.png",
  "imageVersion" : 0,
  "inActiveCellSize" : null,
  "inActiveTimeframes" : null,
  "keys" : { },
  "legend" : [ {
    "color" : {
      "argb" : -13696641
    },
    "entryName" : "32,1",
    "id" : 1,
    "value" : 32.122
  }, {
    "color" : {
      "argb" : -16312961
    },
    "entryName" : "34",
    "id" : 2,
    "value" : 33.987503
  }, {
    "color" : {
      "argb" : -15122305
    },
    "entryName" : "35,9",
    "id" : 3,
    "value" : 35.853
  }, {
    "color" : {
      "argb" : -14719873
    },
    "entryName" : "37,7",
    "id" : 4,
    "value" : 37.718502
  }, {
    "color" : {
      "argb" : -13794421
    },
    "entryName" : "39,6",
    "id" : 5,
    "value" : 39.584
  }, {
    "color" : {
      "argb" : -12934235
    },
    "entryName" : "41,4",
    "id" : 6,
    "value" : 41.4495
  }, {
    "color" : {
      "argb" : -13467809
    },
    "entryName" : "43,3",
    "id" : 7,
    "value" : 43.315002
  }, {
    "color" : {
      "argb" : -10641847
    },
    "entryName" : "45,2",
    "id" : 8,
    "value" : 45.1805
  }, {
    "color" : {
      "argb" : -6169541
    },
    "entryName" : "47",
    "id" : 9,
    "value" : 47.046
  }, {
    "color" : {
      "argb" : -6437109
    },
    "entryName" : "48,9",
    "id" : 10,
    "value" : 48.9115
  }, {
    "color" : {
      "argb" : -4013540
    },
    "entryName" : "50,8",
    "id" : 11,
    "value" : 50.777
  }, {
    "color" : {
      "argb" : -2367897
    },
    "entryName" : "52,6",
    "id" : 12,
    "value" : 52.6425
  }, {
    "color" : {
      "argb" : -3366313
    },
    "entryName" : "54,5",
    "id" : 13,
    "value" : 54.508
  }, {
    "color" : {
      "argb" : -1530502
    },
    "entryName" : "56,4",
    "id" : 14,
    "value" : 56.3735
  }, {
    "color" : {
      "argb" : -2199968
    },
    "entryName" : "58,2",
    "id" : 15,
    "value" : 58.239
  }, {
    "color" : {
      "argb" : -2148303
    },
    "entryName" : "60,1",
    "id" : 16,
    "value" : 60.1045
  }, {
    "color" : {
      "argb" : -7467510
    },
    "entryName" : "62",
    "id" : 17,
    "value" : 61.97
  }, {
    "color" : {
      "argb" : -9493727
    },
    "entryName" : "63,8",
    "id" : 18,
    "value" : 63.8355
  }, {
    "color" : {
      "argb" : -9481646
    },
    "entryName" : "65,7",
    "id" : 19,
    "value" : 65.701
  }, {
    "color" : {
      "argb" : -3947581
    },
    "entryName" : "67,6",
    "id" : 20,
    "value" : 67.5665
  } ],
  "maquetteOverride" : null,
  "maxValue" : [ 0.0, 69.432, 0.0, 1.0 ],
  "minValue" : [ 0.0, 32.122, 0.0, 0.0 ],
  "name" : "Height Map",
  "parentID" : -1,
  "prequels" : { },
  "resultType" : "DSM",
  "showDifference" : false,
  "sortIndex" : 50,
  "type" : "HEIGHTMAP",
  "version" : 63,
  "visible" : true,
  "warnings" : ""
} ]

Limit Queries

version=100: 

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

Get Queries

attributes: 

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

max version: 

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

count: 

https://engine.tygron.com/api/session/items/overlays/count/?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 AreaOverlay

API Model description of AreaOverlay

Name Type Description
areaIDs int[] Areas 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 Color
sortIndex int
type OverlayType Overlay Type
version int
visible boolean

Api Model AttributeOverlay

API Model description of AttributeOverlay

Name Type Description
attribute String
attributeColor TColor Color
attributes Map<String,double[]>
colorAttribute String
colorMultiplier double
colorOffset int
customLegend boolean
id int
imageName String
imageVersion int
legend LegendEntry[]
mapLink MapLink Maplink
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
restColor TColor Color
sortIndex int
type OverlayType Overlay Type
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 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 Overlay Type
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 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 Overlay Type
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 Overlay Type
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 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 Overlay Type
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 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 Overlay Type
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 Overlay Type
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[] Functions ID
functionsColor TColor Color
id int
imageName String
imageVersion int
legend LegendEntry[]
maquetteOverride Map<String,double[]>
name String
parentID int Overlay ID
remainderColor TColor Color
sortIndex int
type OverlayType Overlay Type
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[] Geo Tiffs 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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
version int
visible boolean
warnings String

Api Model LegendEntry

API Model description of LegendEntry

Name Type Description
color TColor Color
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 Overlay Type
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 Net Type
parentID int Overlay ID
showActive boolean
showNetwork boolean
sortIndex int
type OverlayType Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Color
sortIndex int
sources Map<int,int>
type OverlayType Overlay Type
version int
visible boolean

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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
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 Overlay Type
version int
visible boolean
warnings String

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 Overlay Type
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 Overlay Type
version int
visible boolean
warnings String

See also

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