Api session items overlays: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(39 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Overlay]] Endpoints.
API Endpoint: /api/session/items/overlays/


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


Default Query:
Default Query:
Line 7: Line 7:
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ {
<syntaxhighlight lang="text" copy>[ {
  "active" : true,
   "attributes" : {
   "attributes" : {
     "FOO" : [ 1.0 ],
     "CALC_TIME_MS" : [ 0.0 ]
    "PINO" : [ 87.824625 ],
    "SINGLE" : [ 75.624039 ],
    "SJAAKIE" : [ 97.724805 ]
   },
   },
  "calcTimeMS" : 13,
   "colorMultiplier" : 1.0,
   "colorMultiplier" : 1.0,
   "colorOffset" : 127,
   "colorOffset" : 127,
   "customLegend" : false,
   "customLegend" : false,
   "id" : 0,
   "diffLegend" : [ ],
  "imageName" : "normal.png",
   "id" : 3,
  "imageVersion" : 0,
   "imageName" : "heightmap.png",
  "legend" : [ ],
  "maquetteOverride" : null,
  "name" : "namx8",
  "parentID" : -1,
  "sortIndex" : 52,
  "type" : null,
  "version" : 121,
  "visible" : true
}, {
  "attributes" : {
    "PINO" : [ 1.0 ],
    "SJAAKIE" : [ 1.0 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
   "id" : 1,
   "imageName" : "neighborhoods.png",
   "imageVersion" : 0,
   "imageVersion" : 0,
  "inActiveCellSize" : null,
  "inActiveTimeframes" : null,
  "keys" : { },
   "legend" : [ {
   "legend" : [ {
     "color" : {
     "color" : {
       "argb" : -9772392
       "argb" : -13696641
     },
     },
     "entryName" : "buurt",
     "entryName" : "32,1",
     "id" : 1,
     "id" : 1,
     "value" : "-Infinity"
     "value" : 32.122
   }, {
   }, {
     "color" : {
     "color" : {
       "argb" : -1877165
       "argb" : -16312961
     },
     },
     "entryName" : "Sonsbeek-Noord",
     "entryName" : "34",
     "id" : 2,
     "id" : 2,
     "value" : "-Infinity"
     "value" : 33.987503
   }, {
   }, {
     "color" : {
     "color" : {
       "argb" : -16173383
       "argb" : -15122305
     },
     },
     "entryName" : "Onder de Linden",
     "entryName" : "35,9",
     "id" : 3,
     "id" : 3,
     "value" : "-Infinity"
     "value" : 35.853
   }, {
   }, {
     "color" : {
     "color" : {
       "argb" : -6740311
       "argb" : -14719873
     },
     },
     "entryName" : "St. Janskerkstraat e.o.",
     "entryName" : "37,7",
     "id" : 4,
     "id" : 4,
     "value" : "-Infinity"
     "value" : 37.718502
   }, {
   }, {
     "color" : {
     "color" : {
       "argb" : -15232895
       "argb" : -13794421
     },
     },
     "entryName" : "Hazegrietje",
     "entryName" : "39,6",
     "id" : 5,
     "id" : 5,
     "value" : "-Infinity"
     "value" : 39.584
   }, {
   }, {
     "color" : {
     "color" : {
       "argb" : -4609484
       "argb" : -12934235
     },
     },
     "entryName" : "Klarenbeek",
     "entryName" : "41,4",
     "id" : 6,
     "id" : 6,
     "value" : "-Infinity"
     "value" : 41.4495
   } ],
  }, {
   "maquetteOverride" : null,
    "color" : {
   "name" : "aOAcT",
      "argb" : -13467809
   "parentID" : -1,
    },
   "sortIndex" : 51,
    "entryName" : "43,3",
   "type" : "NEIGHBORHOODS",
    "id" : 7,
   "version" : 118,
    "value" : 43.315002
   "visible" : true
  }, {
} ]</syntaxhighlight>
    "color" : {
==Limit Queries==
      "argb" : -10641847
version=100:  
    },
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</syntaxhighlight>
    "entryName" : "45,2",
==Show Queries==
    "id" : 8,
max version:  
    "value" : 45.1805
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</syntaxhighlight>
  }, {
size:  
    "color" : {
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/size/?token=API_TOKEN</syntaxhighlight>
      "argb" : -6169541
Overlays (GeoJSON):  
    },
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN</syntaxhighlight>
    "entryName" : "47",
==Formats==
    "id" : 9,
HTML:  
    "value" : 47.046
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</syntaxhighlight>
  }, {
JSON:  
    "color" : {
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</syntaxhighlight>
      "argb" : -6437109
CSV:  
    },
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=CSV&token=API_TOKEN</syntaxhighlight>
    "entryName" : "48,9",
SSV:  
    "id" : 10,
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SSV&token=API_TOKEN</syntaxhighlight>
    "value" : 48.9115
SMILE:  
  }, {
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SMILE&token=API_TOKEN</syntaxhighlight>
    "color" : {
ZIPJSON:  
      "argb" : -4013540
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
    },
ZIPSMILE:  
    "entryName" : "50,8",
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
    "id" : 11,
==Api Model AeriusOverlay==
    "value" : 50.777
API Model description of AeriusOverlay
  }, {
 
    "color" : {
{|class=wikitable
      "argb" : -2367897
!Name
    },
!Type
    "entryName" : "52,6",
!Description
    "id" : 12,
|-
    "value" : 52.6425
|attributes
  }, {
|Map&lt;String,double[]&gt;
    "color" : {
|
      "argb" : -3366313
|-
    },
|colorMultiplier
    "entryName" : "54,5",
|double
    "id" : 13,
|
    "value" : 54.508
|-
  }, {
|colorOffset
    "color" : {
|int
      "argb" : -1530502
|
    },
|-
    "entryName" : "56,4",
|customLegend
    "id" : 14,
|boolean
    "value" : 56.3735
|
  }, {
|-
    "color" : {
|id
      "argb" : -2199968
|int
    },
|
    "entryName" : "58,2",
|-
    "id" : 15,
|imageName
    "value" : 58.239
|String
  }, {
|
    "color" : {
|-
      "argb" : -2148303
|imageVersion
    },
|int
    "entryName" : "60,1",
|
    "id" : 16,
|-
    "value" : 60.1045
|legend
  }, {
|LegendEntry<nowiki>[]</nowiki>
    "color" : {
|
      "argb" : -7467510
|-
    },
|maquetteOverride
    "entryName" : "62",
|Map&lt;String,double[]&gt;
    "id" : 17,
|
    "value" : 61.97
|-
  }, {
|name
    "color" : {
|String
      "argb" : -9493727
|
    },
|-
    "entryName" : "63,8",
|parentID
    "id" : 18,
|int
    "value" : 63.8355
|[[Overlay]] ID
  }, {
|-
    "color" : {
|sortIndex
      "argb" : -9481646
|int
    },
|
    "entryName" : "65,7",
|-
    "id" : 19,
|type
    "value" : 65.701
|OverlayType
  }, {
|
    "color" : {
|-
      "argb" : -3947581
|version
    },
|int
    "entryName" : "67,6",
|
    "id" : 20,
|-
    "value" : 67.5665
|visible
   } ],
|boolean
   "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==
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</syntaxhighlight>
==Get Queries==
attributes:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</syntaxhighlight>
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model AreaOverlay==
==Api Model AreaOverlay==
API Model description of AreaOverlay
API Model description of AreaOverlay
Line 191: Line 210:
!Description
!Description
|-
|-
|areaIDs
| areaIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Area]] ID  
| [[Area]]s ID  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|colorMultiplier
| colorMultiplier
|double
| double
|
|  
|-
|-
|colorOffset
| colorOffset
|int
| int
|
|  
|-
|-
|customLegend
| customLegend
|boolean
| boolean
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|remainderColor
| remainderColor
|TColor
| TColor
|
| [[Color]]
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|}
|}


==Api Model AttributeKey==
==Api Model AttributeOverlay==
API Enumeration description of AttributeKey
API Model description of AttributeOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|A
| attribute
|
| String
|
|-
| attributeColor
| TColor
| [[Color]]
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| colorAttribute
| String
|
|-
| colorMultiplier
| double
|  
|-
|-
|B
| colorOffset
|
| int
|  
|-
|-
|C
| customLegend
|
| boolean
|  
|-
|-
|D
| id
|
| int
|  
|-
|-
|E
| imageName
|
| String
|  
|-
|-
|F
| imageVersion
|
| int
|  
|-
|-
|G
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|H
| mapLink
|
| MapLink
| [[Maplink]]
|-
|-
|I
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|J
| name
|
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
| restColor
| TColor
| [[Color]]
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|  
|}
|}


==Api Model AttributeOverlay==
==Api Model AvgOverlay==
API Model description of AttributeOverlay
API Model description of AvgOverlay


{|class=wikitable
{|class=wikitable
Line 306: Line 376:
!Description
!Description
|-
|-
|attribute
| active
|String
| boolean
|
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|  
|-
|-
|attributeColor
| diffLegend
|TColor
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|attributes
| id
|Map&lt;String,double[]&gt;
| int
|
|  
|-
|-
|colorAttribute
| imageName
|String
| String
|
|  
|-
|-
|colorMultiplier
| imageVersion
|double
| int
|
|  
|-
|-
|colorOffset
| inActiveCellSize
|int
| double
|
|  
|-
|-
|customLegend
| inActiveTimeframes
|boolean
| int
|
|  
|-
|-
|id
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|imageName
| layerMapLink
|String
| MapLink
|
| [[Maplink]]
|-
|-
|imageVersion
| legend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|mapLink
| maxValue
|MapLink
| float[]
|
|  
|-
|-
|maquetteOverride
| minValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|restColor
| prequels
|TColor
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|sortIndex
| rasterization
|int
| Rasterization
|
|  
|-
|-
|type
| resultType
|OverlayType
| String
|
|  
|-
|-
|version
| showDifference
|int
| boolean
|
|  
|-
|-
|visible
| sortIndex
|boolean
| int
|
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|  
|}
|}


==Api Model AttributeOverlayPredicate==
==Api Model ComboOverlay==
API Model description of AttributeOverlayPredicate
API Model description of ComboOverlay


{|class=wikitable
{|class=wikitable
Line 395: Line 501:
!Description
!Description
|-
|-
|attribute
| active
|String
| boolean
|
|  
|-
|-
|mapLink
| attributes
|MapLink
| Map&lt;String,double[]&gt;
|
|
|}
|-
 
| calcTimeMS
==Api Model AvgModelAttribute==
| long
API Enumeration description of AvgModelAttribute
|  
 
{|class=wikitable
!Name
!Description
|-
|DISTANCE_M
|
|-
|ATTRIBUTE_TIMEFRAMES
|
|-
|DEFAULT_VALUE
|
|-
|SURFACE_ONLY
|
|}
 
==Api Model AvgOverlay==
API Model description of AvgOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|-
|calcTimeMS
| colorMultiplier
|long
| double
|
|  
|-
|-
|colorMultiplier
| colorOffset
|double
| int
|
|  
|-
|-
|colorOffset
| customLegend
|int
| boolean
|
|  
|-
|-
|customLegend
| diffLegend
|boolean
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|diffLegend
| formula
|LegendEntry<nowiki>[]</nowiki>
| String
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| inActiveCellSize
|double
| double
|
|  
|-
|-
|inActiveTimeframes
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|keys
| keys
|Map&lt;String,String&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|layerMapLink
| layerMapLink
|MapLink
| MapLink
|
| [[Maplink]]
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maxValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|prequels
| prequels
|Map&lt;String,PrequelLink&gt;
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|rasterization
| rasterization
|Rasterization
| Rasterization
|
|  
|-
|-
|resultType
| resultType
|String
| String
|
|  
|-
|-
|showDifference
| showDifference
|boolean
| boolean
|
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|LOWEST
| active
|
| boolean
|  
|-
|-
|TERRAIN
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|BRIDGE
| calcTimeMS
|
| long
|}
|  
 
==Api Model ClimateModel==
API Model description of ClimateModel
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|endTemp
| colorMultiplier
|double
| double
|
|  
|-
|-
|endYear
| colorOffset
|int
| int
|
|  
|-
|-
|oxidation
| customLegend
|double
| boolean
|
|  
|-
|-
|soilTempFactor
| diffLegend
|double
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|startTemp
| id
|double
| int
|
|  
|-
|-
|startYear
| imageName
|int
| String
|
|
|}
|-
 
| imageVersion
==Api Model ComboModelAttribute==
| int
API Enumeration description of ComboModelAttribute
|
 
|-
{|class=wikitable
| inActiveCellSize
!Name
| double
!Description
|
|-
| 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
|
|-
|-
|ATTRIBUTE_DEFAULT_VALUE
| visible
|
| boolean
|  
|-
|-
|ATTRIBUTE_SURFACE_ONLY
| warnings
|
| String
|  
|}
|}


==Api Model ComboOverlay==
==Api Model DefaultRasterizationOverlay==
API Model description of ComboOverlay
API Model description of DefaultRasterizationOverlay


{|class=wikitable
{|class=wikitable
Line 621: Line 747:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|colorMultiplier
| colorMultiplier
|double
| double
|
|  
|-
|-
|colorOffset
| colorOffset
|int
| int
|
|  
|-
|-
|customLegend
| customLegend
|boolean
| boolean
|
|  
|-
|-
|diffLegend
| diffLegend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|formula
| id
|String
| int
|
|  
|-
|-
|id
| imageName
|int
| String
|
|  
|-
|-
|imageName
| imageVersion
|String
| int
|
|  
|-
|-
|imageVersion
| inActiveCellSize
|int
| double
|
|  
|-
|-
|inActiveCellSize
| inActiveTimeframes
|double
| int
|
|  
|-
|-
|inActiveTimeframes
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|keys
| layerMapLink
|Map&lt;String,String&gt;
| MapLink
|
| [[Maplink]]
|-
|-
|layerMapLink
| legend
|MapLink
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maquetteOverride
| maxValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| rasterization
|Map&lt;String,PrequelLink&gt;
| Rasterization
|
|  
|-
|-
|rasterization
| resultType
|Rasterization
| String
|
|  
|-
|-
|resultType
| showDifference
|String
| boolean
|
|  
|-
|-
|showDifference
| sortIndex
|boolean
| int
|
|  
|-
|-
|sortIndex
| type
|int
| OverlayType
|
| [[Overlay Type]]
|-
|-
|type
| version
|OverlayType
| int
|
|  
|-
|-
|version
| visible
|int
| boolean
|
|  
|-
|-
|visible
| warnings
|boolean
| String
|
|  
|-
|warnings
|String
|
|}
|}


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


{|class=wikitable
{|class=wikitable
Line 749: Line 871:
!Description
!Description
|-
|-
|ATTRIBUTE
| HEIGHT_MINIMA
|
|
|-
| WATER_TERRAINS
|
|-
| AREAS
|  
|}
|}


==Api Model DefaultOverlay==
==Api Model DistanceOverlay==
API Model description of DefaultOverlay
API Model description of DistanceOverlay


{|class=wikitable
{|class=wikitable
Line 761: Line 889:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|  
|-
|-
|attributes
| colorMultiplier
|Map&lt;String,double[]&gt;
| double
|
|  
|-
|-
|calcTimeMS
| colorOffset
|long
| int
|
|  
|-
|-
|colorMultiplier
| customLegend
|double
| boolean
|
|  
|-
|-
|colorOffset
| diffLegend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|customLegend
| id
|boolean
| int
|
|  
|-
|-
|diffLegend
| imageName
|LegendEntry<nowiki>[]</nowiki>
| String
|
|  
|-
|-
|id
| imageVersion
|int
| int
|
|  
|-
|-
|imageName
| inActiveCellSize
|String
| double
|
|  
|-
|-
|imageVersion
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|inActiveCellSize
| keys
|double
| Map&lt;String,String&gt;
|
|  
|-
|-
|inActiveTimeframes
| layerMapLink
|int
| MapLink
|
| [[Maplink]]
|-
|-
|keys
| legend
|Map&lt;String,String&gt;
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maquetteOverride
| maxValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| rasterization
|Map&lt;String,PrequelLink&gt;
| Rasterization
|
|  
|-
|-
|resultType
| resultType
|String
| String
|
|  
|-
|-
|showDifference
| showDifference
|boolean
| boolean
|
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


==Api Model DefaultRasterizationOverlay==
==Api Model FloodingOverlay==
API Model description of DefaultRasterizationOverlay
API Model description of FloodingOverlay


{|class=wikitable
{|class=wikitable
Line 878: Line 1,014:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcInfo
|long
| String
|
|  
|-
|-
|colorMultiplier
| calcTimeMS
|double
| long
|
|  
|-
|-
|colorOffset
| colorMultiplier
|int
| double
|
|  
|-
|-
|customLegend
| colorOffset
|boolean
| int
|
|  
|-
|-
|diffLegend
| customLegend
|LegendEntry<nowiki>[]</nowiki>
| boolean
|
|  
|-
|-
|id
| diffLegend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageName
| id
|String
| int
|
|  
|-
|-
|imageVersion
| imageName
|int
| String
|
|  
|-
|-
|inActiveCellSize
| imageVersion
|double
| int
|
|  
|-
|-
|inActiveTimeframes
| inActiveCellSize
|int
| double
|
|  
|-
|-
|keys
| inActiveTimeframes
|Map&lt;String,String&gt;
| int
|
|  
|-
|-
|layerMapLink
| keys
|MapLink
| Map&lt;String,String&gt;
|
|  
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maxValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|name
| mode
|String
| Mode
|
|  
|-
|-
|parentID
| name
|int
| String
|[[Overlay]] ID
|  
|-
|-
|prequels
| parentID
|Map&lt;String,PrequelLink&gt;
| int
|
| [[Overlay]] ID
|-
|-
|rasterization
| prequels
|Rasterization
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|resultType
| resultType
|String
| String
|
|  
|-
|-
|showDifference
| showAreas
|boolean
| boolean
|
|  
|-
|-
|sortIndex
| showDifference
|int
| boolean
|
|  
|-
|-
|type
| showSystem
|OverlayType
| boolean
|
|  
|-
|-
|version
| sortIndex
|int
| int
|
|  
|-
|-
|visible
| type
|boolean
| OverlayType
|
| [[Overlay Type]]
|-
|warnings
|String
|
|}
 
==Api Model DefaultResult==
API Enumeration description of DefaultResult
 
{|class=wikitable
!Name
!Description
|-
|-
|DEFAULT
| version
|
| int
|}
|  
 
==Api Model DischargeMethod==
API Enumeration description of DischargeMethod
 
{|class=wikitable
!Name
!Description
|-
|-
|HEIGHT_MINIMA
| visible
|
| boolean
|  
|-
|-
|WATER_TERRAINS
| warnings
|
| String
|  
|-
|-
|AREAS
| weatherID
|
| int
| [[Weather]] ID
|}
|}


==Api Model DistanceOverlay==
==Api Model FunctionOverlay==
API Model description of DistanceOverlay
API Model description of FunctionOverlay


{|class=wikitable
{|class=wikitable
Line 1,031: Line 1,151:
!Description
!Description
|-
|-
|active
| attributes
|boolean
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|attributes
| colorMultiplier
|Map&lt;String,double[]&gt;
| double
|
|  
|-
|-
|calcTimeMS
| colorOffset
|long
| int
|
|  
|-
|-
|colorMultiplier
| customLegend
|double
| boolean
|
|  
|-
|-
|colorOffset
| functionIDs
|int
| int<nowiki>[]</nowiki>
|
| [[Function]]s ID
|-
|-
|customLegend
| functionsColor
|boolean
| TColor
|
| [[Color]]
|-
|-
|diffLegend
| id
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|id
| imageName
|int
| String
|
|  
|-
|-
|imageName
| imageVersion
|String
| int
|
|  
|-
|-
|imageVersion
| legend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|inActiveCellSize
| maquetteOverride
|double
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|inActiveTimeframes
| name
|int
| String
|
|  
|-
|-
|keys
| parentID
|Map&lt;String,String&gt;
| int
|
| [[Overlay]] ID
|-
|-
|layerMapLink
| remainderColor
|MapLink
| TColor
|
| [[Color]]
|-
|-
|legend
| sortIndex
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|maquetteOverride
| type
|Map&lt;String,double[]&gt;
| OverlayType
|
| [[Overlay Type]]
|-
|-
|maxValue
| version
|float[]
| int
|
|  
|-
|-
|minValue
| visible
|float[]
| boolean
|
|  
|-
|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 DistanceResult==
==Api Model GeoTiffOverlay==
API Enumeration description of DistanceResult
API Model description of GeoTiffOverlay
 
{|class=wikitable
!Name
!Description
|-
|ZONE
|
|-
|SIGHT
|
|}
 
==Api Model FloodingOverlay==
API Model description of FloodingOverlay


{|class=wikitable
{|class=wikitable
Line 1,170: Line 1,232:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcInfo
| calcTimeMS
|String
| long
|
|  
|-
|-
|calcTimeMS
| colorMultiplier
|long
| double
|
|  
|-
|-
|colorMultiplier
| colorOffset
|double
| int
|
|  
|-
|-
|colorOffset
| customLegend
|int
| boolean
|
|  
|-
|-
|customLegend
| diffLegend
|boolean
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|diffLegend
| geoTiffIDs
|LegendEntry<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|
| [[GeoTIFF|Geo Tiffs]] ID
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| inActiveCellSize
|double
| double
|
|  
|-
|-
|inActiveTimeframes
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|keys
| keys
|Map&lt;String,String&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maxValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|mode
| name
|Mode
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| resultType
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|resultType
| showDifference
|String
| boolean
|
|  
|-
|-
|showAreas
| sortIndex
|boolean
| int
|
|  
|-
|-
|showDifference
| type
|boolean
| OverlayType
|
| [[Overlay Type]]
|-
|-
|showSystem
| version
|boolean
| int
|
|  
|-
|-
|sortIndex
| visible
|int
| boolean
|
|  
|-
|-
|type
| warnings
|OverlayType
| String
|
|  
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|-
|weatherID
|int
|[[Weather]] ID
|}
|}


==Api Model FunctionOverlay==
==Api Model GridOverlay==
API Model description of FunctionOverlay
API Model description of GridOverlay


{|class=wikitable
{|class=wikitable
Line 1,307: Line 1,353:
!Description
!Description
|-
|-
|attributes
| active
|Map&lt;String,double[]&gt;
| boolean
|
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|
|-
| diffLegend
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|colorMultiplier
| id
|double
| int
|
|  
|-
|-
|colorOffset
| imageName
|int
| String
|
|  
|-
|-
|customLegend
| imageVersion
|boolean
| int
|
|  
|-
|-
|functionIDs
| inActiveCellSize
|int<nowiki>[]</nowiki>
| double
|[[Function]] ID
|  
|-
|-
|functionsColor
| inActiveTimeframes
|TColor
| int
|
|  
|-
|-
|id
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|imageName
| legend
|String
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageVersion
| maquetteOverride
|int
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|legend
| maxValue
|LegendEntry<nowiki>[]</nowiki>
| float[]
|
|  
|-
|-
|maquetteOverride
| minValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|remainderColor
| prequels
|TColor
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|sortIndex
| resultType
|int
| String
|
|  
|-
|-
|type
| showDifference
|OverlayType
| boolean
|
|  
|-
|-
|version
| sortIndex
|int
| int
|
|  
|-
|-
|visible
| type
|boolean
| OverlayType
|
| [[Overlay Type]]
|}
 
==Api Model GasType==
API Enumeration description of GasType
 
{|class=wikitable
!Name
!Description
|-
|-
|NOX
| version
|
| int
|  
|-
|-
|NO2
| visible
|
| boolean
|}
|  
 
==Api Model GeoTiffAttribute==
API Enumeration description of GeoTiffAttribute
 
{|class=wikitable
!Name
!Description
|-
|-
|BAND
| warnings
|
| String
|  
|}
|}


==Api Model GeoTiffOverlay==
==Api Model GroundwaterOverlay==
API Model description of GeoTiffOverlay
API Model description of GroundwaterOverlay


{|class=wikitable
{|class=wikitable
Line 1,413: Line 1,470:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcInfo
|long
| String
|
|  
|-
|-
|colorMultiplier
| calcTimeMS
|double
| long
|
|  
|-
|-
|colorOffset
| colorMultiplier
|int
| double
|
|  
|-
|-
|customLegend
| colorOffset
|boolean
| int
|
|  
|-
|-
|diffLegend
| customLegend
|LegendEntry<nowiki>[]</nowiki>
| boolean
|
|  
|-
|-
|geoTiffIDs
| diffLegend
|int<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|[[GeoTIFF]] ID
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| inActiveCellSize
|double
| double
|
|  
|-
|-
|inActiveTimeframes
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|keys
| keys
|Map&lt;String,String&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maxValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|name
| mode
|String
| Mode
|
|  
|-
|-
|parentID
| name
|int
| String
|[[Overlay]] ID
|  
|-
|-
|prequels
| parentID
|Map&lt;String,PrequelLink&gt;
| int
|
| [[Overlay]] ID
|-
|-
|resultType
| prequels
|String
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|showDifference
| resultType
|boolean
| String
|
|  
|-
|-
|sortIndex
| showAreas
|int
| boolean
|
|  
|-
|-
|type
| showDifference
|OverlayType
| boolean
|
|  
|-
|-
|version
| showSystem
|int
| boolean
|
|  
|-
|-
|visible
| sortIndex
|boolean
| int
|
|  
|-
|-
|warnings
| type
|String
| OverlayType
|
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|  
|-
| weatherID
| int
| [[Weather]] ID
|}
|}


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


{|class=wikitable
{|class=wikitable
Line 1,533: Line 1,606:
!Description
!Description
|-
|-
|NEAREST
| UNESCO
|
|  
|-
|-
|INTERPOLATED
| DPRA
|
|  
|}
|}


==Api Model GridModelAttribute==
==Api Model HeatOverlay==
API Enumeration description of GridModelAttribute
API Model description of HeatOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ITERATION_ACTIVE
| active
|
| boolean
|  
|-
|-
|SKIP_NO_DATA
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|GPU_CLUSTER_INDEX
| calcInfo
|
| String
|}
|  
 
==Api Model GridOverlay==
API Model description of GridOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
| calcTimeMS
|boolean
| long
|
|  
|-
|-
|attributes
| colorMultiplier
|Map&lt;String,double[]&gt;
| double
|
|  
|-
|-
|calcTimeMS
| colorOffset
|long
| int
|
|  
|-
|-
|colorMultiplier
| customLegend
|double
| boolean
|
|  
|-
|-
|colorOffset
| diffLegend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|customLegend
| id
|boolean
| int
|
|  
|-
|-
|diffLegend
| imageName
|LegendEntry<nowiki>[]</nowiki>
| String
|
|  
|-
|-
|id
| imageVersion
|int
| int
|
|  
|-
|-
|imageName
| inActiveCellSize
|String
| double
|
|  
|-
|-
|imageVersion
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|inActiveCellSize
| keys
|double
| Map&lt;String,String&gt;
|
|  
|-
|-
|inActiveTimeframes
| legend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|keys
| maquetteOverride
|Map&lt;String,String&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|legend
| maxValue
|LegendEntry<nowiki>[]</nowiki>
| float[]
|
|  
|-
|-
|maquetteOverride
| minValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| model
|float[]
| HeatModel
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| resultType
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|resultType
| showDifference
|String
| boolean
|
|  
|-
|-
|showDifference
| sortIndex
|boolean
| int
|
|  
|-
|-
|sortIndex
| type
|int
| OverlayType
|
| [[Overlay Type]]
|-
|-
|type
| version
|OverlayType
| int
|
|  
|-
|-
|version
| visible
|int
| boolean
|
|  
|-
|-
|visible
| warnings
|boolean
| String
|
|  
|-
|warnings
|String
|
|}
|}


==Api Model GroundwaterOverlay==
==Api Model HeightOverlay==
API Model description of GroundwaterOverlay
API Model description of HeightOverlay


{|class=wikitable
{|class=wikitable
Line 1,682: Line 1,746:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcInfo
|String
|
|-
|calcTimeMS
|long
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|-
|customLegend
| attributes
|boolean
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|diffLegend
| calcTimeMS
|LegendEntry<nowiki>[]</nowiki>
| long
|
|  
|-
|-
|id
| colorMultiplier
|int
| double
|
|  
|-
|-
|imageName
| colorOffset
|String
| int
|
|  
|-
|-
|imageVersion
| customLegend
|int
| boolean
|
|  
|-
|-
|inActiveCellSize
| diffLegend
|double
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|inActiveTimeframes
| id
|int
| int
|
|  
|-
|-
|keys
| imageName
|Map&lt;String,String&gt;
| String
|
|  
|-
|-
|legend
| imageVersion
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|maquetteOverride
| inActiveCellSize
|Map&lt;String,double[]&gt;
| double
|
|  
|-
|-
|maxValue
| inActiveTimeframes
|float[]
| int
|
|  
|-
|-
|minValue
| keys
|float[]
| Map&lt;String,String&gt;
|
|  
|-
|-
|mode
| legend
|Mode
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|name
| maquetteOverride
|String
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|parentID
| maxValue
|int
| float[]
|[[Overlay]] ID
|  
|-
|-
|prequels
| minValue
|Map&lt;String,PrequelLink&gt;
| float[]
|
|  
|-
|-
|resultType
| name
|String
| String
|
|  
|-
|-
|showAreas
| parentID
|boolean
| int
|
| [[Overlay]] ID
|-
|-
|showDifference
| prequels
|boolean
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|showSystem
| resultType
|boolean
| String
|
|  
|-
|-
|sortIndex
| showDifference
|int
| boolean
|
|  
|-
|-
|type
| sortIndex
|OverlayType
| int
|
|  
|-
|-
|version
| type
|int
| OverlayType
|
| [[Overlay Type]]
|-
|-
|visible
| version
|boolean
| int
|
|  
|-
|-
|warnings
| visible
|String
| boolean
|
|  
|-
|-
|weatherID
| warnings
|int
| String
|[[Weather]] ID
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|DATES
| attributes
|
| Map&lt;String,double[]&gt;
|-
|  
|DAILY_AVG_RADIATION
|
|-
|DAILY_TEMPERATURE_MAX
|
|-
|-
|DAILY_TEMPERATURE_MIN
| colorMultiplier
|
| double
|  
|-
|-
|EXCLUDE_BUILDINGS
| colorOffset
|
| int
|  
|-
|-
|EXCLUDE_WATER
| customLegend
|
| boolean
|  
|-
|-
|EXCLUDE_FOLIAGE_HEIGHT_M
| id
|
| int
|  
|-
|-
|FOLIAGE_AREAS
| imageName
|
| String
|  
|-
|-
|HOURLY_RADIATION
| imageNames
|
| String<nowiki>[]</nowiki>
|  
|-
|-
|HOURLY_TEMPERATURE
| imageVersion
|
| int
|  
|-
|-
|HOURLY_HUMIDITY
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|SUN_ALTITUDE
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|SUN_AZIMUTH
| name
|
| String
|  
|-
|-
|SUN_DAILY_MOTION
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|WIND_DIRECTION
| sortIndex
|
| int
|  
|-
|-
|WIND_SPEED
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|DAILY_AVG_WIND_SPEED
| version
|
| int
|  
|-
|-
|MAX_SHADOW_DISTANCE
| visible
|
| boolean
|-
|  
|MAX_TRUNK_DISTANCE
|
|-
|WIND_DECLINE_ANGLE
|
|}
|}


==Api Model HeatKey==
==Api Model InferenceOverlay==
API Enumeration description of HeatKey
API Model description of InferenceOverlay
 
{|class=wikitable
!Name
!Description
|-
|FOLIAGE_HEIGHT
|
|}
 
==Api Model HeatModel==
API Enumeration description of HeatModel
 
{|class=wikitable
!Name
!Description
|-
|UNESCO
|
|-
|DPRA
|
|}
 
==Api Model HeatOverlay==
API Model description of HeatOverlay


{|class=wikitable
{|class=wikitable
Line 1,912: Line 1,936:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcInfo
| calcTimeMS
|String
| long
|
|  
|-
|-
|calcTimeMS
| colorMultiplier
|long
| double
|
|  
|-
|-
|colorMultiplier
| colorOffset
|double
| int
|
|  
|-
|-
|colorOffset
| customLegend
|int
| boolean
|
|  
|-
|-
|customLegend
| diffLegend
|boolean
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|diffLegend
| id
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|id
| imageName
|int
| String
|
|  
|-
|-
|imageName
| imageVersion
|String
| int
|
|  
|-
|-
|imageVersion
| inActiveCellSize
|int
| double
|
|  
|-
|-
|inActiveCellSize
| inActiveTimeframes
|double
| int
|
|  
|-
|-
|inActiveTimeframes
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|keys
| legend
|Map&lt;String,String&gt;
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maquetteOverride
| maxValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|model
| neuralNetworkID
|HeatModel
| int
|
| [[Neural Network]] ID
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| resultType
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|resultType
| showDifference
|String
| boolean
|
|  
|-
|-
|showDifference
| sortIndex
|boolean
| int
|
|  
|-
|-
|sortIndex
| tensorLinks
|int
| TensorLink<nowiki>[]</nowiki>
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|FOLIAGE_HEIGHT
| active
|
| boolean
|  
|-
|-
|BUILDING_ELEVATION
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|TERRAIN_ELEVATION
| calcTimeMS
|
| long
|}
|  
 
|-
==Api Model HeatResult==
| colorMultiplier
API Enumeration description of HeatResult
| double
 
|  
{|class=wikitable
!Name
!Description
|-
|-
|BOWEN_RATIO
| colorOffset
|
| int
|  
|-
|-
|FOLIAGE
| customLegend
|
| boolean
|  
|-
|-
|PET
| diffLegend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|PET_RELATIVE
| id
|
| int
|  
|-
|-
|SHADE
| imageName
|
| String
|  
|-
|-
|SKY_VIEW
| imageVersion
|
| int
|  
|-
|-
|SKY_VIEW_AVG
| inActiveCellSize
|
| double
|  
|-
|-
|TEMPERATURE_ATMOSPHERE
| inActiveTimeframes
|
| int
|  
|-
|-
|UHI
| keys
|
| Map&lt;String,String&gt;
|  
|-
|-
|VEGETATION
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|VEGETATION_AVG
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|WIND_SPEED
| 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 HeightAttribute==
==Api Model LegendEntry==
API Enumeration description of HeightAttribute
API Model description of LegendEntry


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ZONING_PERMIT_REQUIRED
| color
|
| TColor
| [[Color]]
|-
| entryName
| String
|
|-
| id
| int
|
|-
| value
| float
|  
|}
|}


==Api Model HeightOverlay==
==Api Model Mode==
API Model description of HeightOverlay
API Enumeration description of Mode


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|active
| SPEED
|boolean
|  
|
|-
|-
|attributes
| AVERAGE
|Map&lt;String,double[]&gt;
|  
|
|-
|-
|calcTimeMS
| ACCURACY
|long
|  
|
|}
 
==Api Model NO2Overlay==
API Model description of NO2Overlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|colorMultiplier
| active
|double
| boolean
|
|  
|-
|-
|colorOffset
| attributes
|int
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|customLegend
| calcTimeMS
|boolean
| long
|
|  
|-
|-
|diffLegend
| colorMultiplier
|LegendEntry<nowiki>[]</nowiki>
| double
|
|  
|-
|-
|id
| colorOffset
|int
| int
|
|  
|-
|-
|imageName
| customLegend
|String
| boolean
|
|  
|-
|-
|imageVersion
| diffLegend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|inActiveCellSize
| id
|double
| int
|
|  
|-
|-
|inActiveTimeframes
| imageName
|int
| String
|
|  
|-
|-
|keys
| imageVersion
|Map&lt;String,String&gt;
| int
|
|  
|-
|-
|legend
| inActiveCellSize
|LegendEntry<nowiki>[]</nowiki>
| double
|
|  
|-
|-
|maquetteOverride
| inActiveTimeframes
|Map&lt;String,double[]&gt;
| int
|
|  
|-
|-
|maxValue
| keys
|float[]
| Map&lt;String,String&gt;
|
|  
|-
|-
|minValue
| legend
|float[]
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|name
| maquetteOverride
|String
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|parentID
| maxValue
|int
| float[]
|[[Overlay]] ID
|  
|-
|-
|prequels
| minValue
|Map&lt;String,PrequelLink&gt;
| float[]
|
|  
|-
|-
|resultType
| name
|String
| String
|
|  
|-
|-
|showDifference
| parentID
|boolean
| int
|
| [[Overlay]] ID
|-
|-
|sortIndex
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|type
| resultType
|OverlayType
| String
|
|  
|-
|-
|version
| showDifference
|int
| boolean
|
|  
|-
|-
|visible
| sortIndex
|boolean
| int
|
|  
|-
|-
|warnings
| type
|String
| OverlayType
|
| [[Overlay Type]]
|}
 
==Api Model HeightResult==
API Enumeration description of HeightResult
 
{|class=wikitable
!Name
!Description
|-
|-
|DSM
| version
|
| int
|  
|-
|-
|DTM
| visible
|
| boolean
|  
|-
|-
|FLOORS
| warnings
|
| String
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ALPHA
| attributes
|
| Map&lt;String,double[]&gt;
|}
|  
 
|-
==Api Model ImageOverlay==
| colorMultiplier
API Model description of ImageOverlay
| double
 
|  
{|class=wikitable
!Name
!Type
!Description
|-
|-
|attributes
| colorOffset
|Map&lt;String,double[]&gt;
| int
|
|  
|-
|-
|colorMultiplier
| customLegend
|double
| boolean
|
|  
|-
|-
|colorOffset
| id
|int
| int
|
|  
|-
|-
|customLegend
| imageName
|boolean
| String
|
|  
|-
|-
|id
| imageVersion
|int
| int
|
|  
|-
|-
|imageName
| legend
|String
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageNames
| maquetteOverride
|String<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|imageVersion
| name
|int
| String
|
|  
|-
|-
|legend
| netType
|LegendEntry<nowiki>[]</nowiki>
| NetType
|
| [[Net Type]]
|-
|-
|maquetteOverride
| parentID
|Map&lt;String,double[]&gt;
| int
|
| [[Overlay]] ID
|-
|-
|name
| showActive
|String
| boolean
|
|  
|-
|-
|parentID
| showNetwork
|int
| boolean
|[[Overlay]] ID
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
Line 2,326: Line 2,417:
!Description
!Description
|-
|-
|MASK_THRESHOLD
| ELECTRICITY
|
|  
|-
|SCORE_THRESHOLD
|
|-
|INFERENCE_MODE
|
|-
|-
|STRIDE_FRACTION
| GAS
|
|  
|-
|-
|BOX_OVERLAP
| HEAT
|
|  
|-
|-
|PRIORITIZE_LABELS
| INTERNET
|
|  
|-
|-
|GPU_MEMORY_MB
| SEWER
|
|  
|}
|}


==Api Model InferenceMode==
==Api Model NoiseOverlay==
API Enumeration description of InferenceMode
API Model description of NoiseOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|CLASSIFICATION
| active
|
| boolean
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|  
|-
|-
|BBOX_DETECTION
| colorMultiplier
|
| double
|}
|  
 
|-
==Api Model InferenceOverlay==
| colorOffset
API Model description of InferenceOverlay
| int
 
|  
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
| customLegend
|boolean
| boolean
|
|  
|-
|-
|attributes
| diffLegend
|Map&lt;String,double[]&gt;
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|calcTimeMS
| id
|long
| int
|
|  
|-
|-
|colorMultiplier
| imageName
|double
| String
|
|  
|-
|-
|colorOffset
| imageVersion
|int
| int
|
|  
|-
|-
|customLegend
| inActiveCellSize
|boolean
| double
|
|  
|-
|-
|diffLegend
| inActiveTimeframes
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|id
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|imageName
| legend
|String
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageVersion
| maquetteOverride
|int
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|inActiveCellSize
| maxValue
|double
| float[]
|
|  
|-
|-
|inActiveTimeframes
| minValue
|int
| float[]
|
|  
|-
|-
|keys
| name
|Map&lt;String,String&gt;
| String
|
|  
|-
|-
|legend
| parentID
|LegendEntry<nowiki>[]</nowiki>
| int
|
| [[Overlay]] ID
|-
|-
|maquetteOverride
| prequels
|Map&lt;String,double[]&gt;
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|maxValue
| resultType
|float[]
| String
|
|  
|-
|-
|minValue
| showDifference
|float[]
| boolean
|
|  
|-
|-
|name
| sortIndex
|String
| int
|
|  
|-
|-
|neuralNetworkID
| type
|int
| OverlayType
|[[Neural Network]] ID
| [[Overlay Type]]
|-
|-
|parentID
| version
|int
| int
|[[Overlay]] ID
|  
|-
|-
|prequels
| visible
|Map&lt;String,PrequelLink&gt;
| boolean
|
|  
|-
|-
|resultType
| warnings
|String
| String
|
|  
|}
 
==Api Model Overlay==
API Model description of Overlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|showDifference
| attributes
|boolean
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|sortIndex
| colorMultiplier
|int
| double
|
|  
|-
|-
|tensorLinks
| colorOffset
|TensorLink<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|type
| customLegend
|OverlayType
| boolean
|
|  
|-
|-
|version
| id
|int
| int
|
|  
|-
|-
|visible
| imageName
|boolean
| String
|
|  
|-
|-
|warnings
| imageVersion
|String
| int
|
|  
|}
 
==Api Model InferencePrequel==
API Enumeration description of InferencePrequel
 
{|class=wikitable
!Name
!Description
|-
|-
|A
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|B
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|C
| name
|
| String
|}
|  
 
==Api Model InferenceResult==
API Enumeration description of InferenceResult
 
{|class=wikitable
!Name
!Description
|-
|-
|LABELS
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|SCORES
| sortIndex
|
| int
|  
|-
|-
|BOXES
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|MASKS
| version
|
| int
|  
|-
|-
|DEBUG_GT_INSTANCES
| visible
|
| boolean
|-
|  
|CENTER_POINTS
|
|}
|}


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


{|class=wikitable
{|class=wikitable
Line 2,537: Line 2,626:
!Description
!Description
|-
|-
|A
| OWNERSHIP
|
|  
|-
|-
|B
| OWNERSHIP_GRID
|
|  
|-
|-
|C
| ZIP_CODES
|
|  
|-
|-
|D
| ZONING
|
|  
|-
|-
|E
| NEIGHBORHOODS
|
|  
|-
|-
|F
| MUNICIPALITIES
|
|  
|-
|-
|G
| SCENARIO
|
|  
|-
|-
|H
| VACANCY
|
|  
|-
|-
|I
| HEAT_STRESS
|
|  
|-
|-
|J
| SHADOW
|
|  
|}
|-
 
| TRAFFIC_DENSITY
==Api Model IterationAttribute==
|
API Enumeration description of IterationAttribute
|-
 
| TRAFFIC_NO2
{|class=wikitable
|
!Name
|-
!Description
| TRAFFIC_NOISE
|
|-
| LIVABILITY
|
|-
| AERIUS
|
|-
| RAINFALL
|  
|-
| FLOODING
|
|-
| GROUNDWATER
|
|-
|-
|MODULUS
| WATERSHED
|
|  
|-
|-
|TIMEFRAME_TIMES
| SUBSIDENCE
|
|  
|}
 
==Api Model IterationOverlay==
API Model description of IterationOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|active
| WATERWIJZER
|boolean
|  
|
|-
|-
|attributes
| AVG
|Map&lt;String,double[]&gt;
|  
|
|-
|-
|calcTimeMS
| COMBO
|long
|  
|
|-
|-
|colorMultiplier
| DISTANCE
|double
|  
|
|-
|-
|colorOffset
| SIGHT_DISTANCE
|int
|  
|
|-
|-
|customLegend
| TRAVEL_DISTANCE
|boolean
|  
|
|-
|-
|diffLegend
| INFERENCE
|LegendEntry<nowiki>[]</nowiki>
|  
|
|-
|-
|id
| ITERATION
|int
|  
|
|-
|-
|imageName
| GEO_TIFF
|String
|  
|
|-
|-
|imageVersion
| WMS
|int
|  
|
|-
|-
|inActiveCellSize
| WCS
|double
|  
|
|-
|-
|inActiveTimeframes
| IMAGE
|int
|  
|
|-
|-
|keys
| AREA
|Map&lt;String,String&gt;
|  
|
|-
|-
|legend
| ATTRIBUTE
|LegendEntry<nowiki>[]</nowiki>
|  
|
|-
|-
|maquetteOverride
| FUNCTION
|Map&lt;String,double[]&gt;
|  
|
|-
|-
|maxValue
| SATELLITE
|float[]
|  
|
|-
|-
|minValue
| HEIGHTMAP
|float[]
|  
|
|-
|-
|name
| UNDERGROUND
|String
|  
|
|-
|-
|parentID
| SOURCE
|int
|  
|[[Overlay]] ID
|-
|-
|prequels
| NETWORK_OWNERSHIP
|Map&lt;String,PrequelLink&gt;
|  
|
|-
|-
|resultType
| NETWORK_OVERVIEW
|String
|  
|
|-
|-
|showDifference
| NETWORK_DISTANCE
|boolean
|  
|
|-
|-
|sortIndex
| RESULT_CHILD
|int
|  
|
|-
|-
|type
| TEST
|OverlayType
|  
|
|-
|-
|version
| DISTURBANCE_DISTANCE
|int
|  
|
|-
|-
|visible
| SAFETY_DISTANCE
|boolean
|  
|
|-
|-
|warnings
| DEPRECATED
|String
|  
|
|}
|}


==Api Model IterationPrequel==
==Api Model RainOverlay==
API Enumeration description of IterationPrequel
API Model description of RainOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|ITERATION
| active
|
| boolean
|}
|  
 
|-
==Api Model MinMax==
| attributes
API Enumeration description of MinMax
| Map&lt;String,double[]&gt;
 
|  
{|class=wikitable
|-
!Name
| calcInfo
!Description
| String
|-
|  
|NEVER
|
|-
|LARGE_CELL
|
|-
|ALWAYS
|
|}
 
==Api Model Mode==
API Enumeration description of Mode
 
{|class=wikitable
!Name
!Description
|-
|-
|SPEED
| calcTimeMS
|
| long
|  
|-
|-
|AVERAGE
| colorMultiplier
|
| double
|  
|-
|-
|ACCURACY
| colorOffset
|
| int
|}
|  
 
==Api Model NO2Overlay==
API Model description of NO2Overlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|-
|attributes
| customLegend
|Map&lt;String,double[]&gt;
| boolean
|
|  
|-
|-
|calcTimeMS
| diffLegend
|long
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|colorMultiplier
| id
|double
| int
|
|  
|-
|-
|colorOffset
| imageName
|int
| String
|
|  
|-
|-
|customLegend
| imageVersion
|boolean
| int
|
|  
|-
|-
|diffLegend
| inActiveCellSize
|LegendEntry<nowiki>[]</nowiki>
| double
|
|  
|-
|-
|id
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|imageName
| keys
|String
| Map&lt;String,String&gt;
|
|  
|-
|-
|imageVersion
| legend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|inActiveCellSize
| maquetteOverride
|double
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|inActiveTimeframes
| maxValue
|int
| float[]
|
|  
|-
|-
|keys
| minValue
|Map&lt;String,String&gt;
| float[]
|
|  
|-
|-
|legend
| mode
|LegendEntry<nowiki>[]</nowiki>
| Mode
|
|  
|-
|-
|maquetteOverride
| name
|Map&lt;String,double[]&gt;
| String
|
|  
|-
|-
|maxValue
| parentID
|float[]
| int
|
| [[Overlay]] ID
|-
|-
|minValue
| prequels
|float[]
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|name
| resultType
|String
| String
|
|  
|-
|-
|parentID
| showAreas
|int
| boolean
|[[Overlay]] ID
|  
|-
|-
|prequels
| showDifference
|Map&lt;String,PrequelLink&gt;
| boolean
|
|  
|-
|-
|resultType
| showSystem
|String
| boolean
|
|  
|-
|-
|showDifference
| sortIndex
|boolean
| int
|
|  
|-
|-
|sortIndex
| type
|int
| OverlayType
|
| [[Overlay Type]]
|-
|-
|type
| version
|OverlayType
| int
|
|  
|-
|-
|version
| visible
|int
| boolean
|
|  
|-
|-
|visible
| warnings
|boolean
| String
|
|  
|-
|-
|warnings
| weatherID
|String
| int
|
| [[Weather]] ID
|}
|}


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


{|class=wikitable
{|class=wikitable
Line 2,868: Line 2,912:
!Description
!Description
|-
|-
|CONCENTRATION
| FIRST
|
|  
|-
|-
|EMISSION_NO2
| MIN
|
|  
|-
|-
|EMISSION_NOX
| MAX
|
|  
|-
|-
|TREEFACTOR
| SINGLE_LAYER
|
|  
|-
|-
|TREES
| GRID
|
|  
|}
|}


==Api Model NetOverlay==
==Api Model RasterizationOverlay==
API Model description of NetOverlay
API Model description of RasterizationOverlay


{|class=wikitable
{|class=wikitable
Line 2,892: Line 2,936:
!Description
!Description
|-
|-
|attributes
| active
|Map&lt;String,double[]&gt;
| boolean
|
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| customLegend
| boolean
|
|-
| diffLegend
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|colorMultiplier
| id
|double
| int
|
|  
|-
|-
|colorOffset
| imageName
|int
| String
|
|  
|-
|-
|customLegend
| imageVersion
|boolean
| int
|
|  
|-
|-
|id
| inActiveCellSize
|int
| double
|
|  
|-
|-
|imageName
| inActiveTimeframes
|String
| int
|
|  
|-
|-
|imageVersion
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|legend
| layerMapLink
|LegendEntry<nowiki>[]</nowiki>
| MapLink
|
| [[Maplink]]
|-
|-
|maquetteOverride
| legend
|Map&lt;String,double[]&gt;
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|name
| maquetteOverride
|String
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|netType
| maxValue
|NetType
| float[]
|
|  
|-
|-
|parentID
| minValue
|int
| float[]
|[[Overlay]] ID
|  
|-
|-
|showActive
| name
|boolean
| String
|
|  
|-
|-
|showNetwork
| parentID
|boolean
| int
|
| [[Overlay]] ID
|-
|-
|sortIndex
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|type
| rasterization
|OverlayType
| Rasterization
|
|  
|-
|-
|version
| resultType
|int
| String
|
|  
|-
|-
|visible
| showDifference
|boolean
| boolean
|
|
|-
| sortIndex
| int
|
|-
| type
| OverlayType
| [[Overlay Type]]
|-
| version
| int
|
|-
| visible
| boolean
|
|-
| warnings
| String
|  
|}
|}


==Api Model NoPrequel==
==Api Model ResultChildOverlay==
API Enumeration description of NoPrequel
API Model description of ResultChildOverlay
 
{|class=wikitable
!Name
!Description
|}
 
==Api Model NoiseOverlay==
API Model description of NoiseOverlay


{|class=wikitable
{|class=wikitable
Line 2,981: Line 3,061:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|colorMultiplier
| colorMultiplier
|double
| double
|
|  
|-
|-
|colorOffset
| colorOffset
|int
| int
|
|  
|-
|-
|customLegend
| customLegend
|boolean
| boolean
|
|  
|-
|-
|diffLegend
| diffLegend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| inActiveCellSize
|double
| double
|
|  
|-
|-
|inActiveTimeframes
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|keys
| keys
|Map&lt;String,String&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|legend
| legend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maxValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|parentID
| parentID
|int
| int
|[[Overlay]] ID  
| [[Overlay]] ID  
|-
|-
|prequels
| prequels
|Map&lt;String,PrequelLink&gt;
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|resultType
| resultType
|String
| String
|
|  
|-
|-
|showDifference
| showDifference
|boolean
| boolean
|
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


==Api Model NoiseResult==
==Api Model ResultParentOverlay==
API Enumeration description of NoiseResult
API Model description of ResultParentOverlay


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|NOISE_DB
| active
|
| boolean
|
|-
| attributes
| Map&lt;String,double[]&gt;
|  
|-
|-
|EMISSION
| calcTimeMS
|
| long
|}
|  
 
|-
==Api Model Operator (AvgOverlay)==
| colorMultiplier
API Enumeration description of Operator
| double
 
|
{|class=wikitable
|-
!Name
| colorOffset
!Description
| int
|
|-
| customLegend
| boolean
|
|-
| diffLegend
| LegendEntry<nowiki>[]</nowiki>
|
|-
| id
| int
|
|-
|-
|AVG
| imageName
|
| String
|  
|-
|-
|AVG_INTERPOLATED
| imageVersion
|
| int
|  
|-
|-
|MAX
| inActiveCellSize
|
| double
|  
|-
|-
|MIN
| inActiveTimeframes
|
| int
|}
|  
 
==Api Model Operator (ComboOverlay)==
API Enumeration description of Operator
 
{|class=wikitable
!Name
!Description
|-
|-
|SIN
| keys
|
| Map&lt;String,String&gt;
|  
|-
|-
|COS
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|TAN
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|ASIN
| maxValue
|
| float[]
|  
|-
|-
|ACOS
| minValue
|
| float[]
|  
|-
|-
|ATAN
| name
|
| String
|  
|-
|-
|SQRT
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|ROUND
| prequels
|
| Map&lt;String,PrequelLink&gt;
|  
|-
|-
|FLOOR
| resultType
|
| String
|  
|-
|-
|CEIL
| showDifference
|
| boolean
|  
|-
|-
|ABS
| sortIndex
|
| int
|  
|-
|-
|EXP
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|LN
| version
|
| int
|  
|-
|-
|LOG
| visible
|
| boolean
|  
|-
|-
|RANDOM
| warnings
|
| String
|
|}
 
==Api Model SatelliteOverlay==
API Model description of SatelliteOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|ERF
| active
|
| boolean
|  
|-
|-
|GTE
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|GT
| calcTimeMS
|
| long
|  
|-
|-
|LTE
| colorMultiplier
|
| double
|  
|-
|-
|LT
| colorOffset
|
| int
|  
|-
|-
|NEQ
| customLegend
|
| boolean
|  
|-
|-
|EQ
| diffLegend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|IF
| id
|
| int
|  
|-
|-
|AND
| imageName
|
| String
|  
|-
|-
|OR
| imageVersion
|
| int
|  
|-
|-
|SWITCH
| inActiveCellSize
|
| double
|  
|-
|-
|ADD
| inActiveTimeframes
|
| int
|  
|-
|-
|MUL
| keys
|
| Map&lt;String,String&gt;
|  
|-
|-
|DIV
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|SUB
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|MAX
| maxValue
|
| float[]
|  
|-
|-
|MIN
| minValue
|
| float[]
|  
|-
|-
|AVG
| name
|
| String
|  
|-
|-
|POW
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|PERCENTILE
| prequels
|
| Map&lt;String,PrequelLink&gt;
|  
|-
|-
|AVG_GTE_PERCENTILE
| resultType
|
| String
|  
|-
|-
|AVG_LTE_PERCENTILE
| showDifference
|
| boolean
|  
|-
|-
|COLOR
| sortIndex
|
| int
|  
|-
|-
|RED
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|GREEN
| version
|
| int
|  
|-
|-
|BLUE
| visible
|
| boolean
|  
|-
|-
|ALPHA
| warnings
|
| String
|  
|}
|}


==Api Model Overlay==
==Api Model ServiceOverlay==
API Model description of Overlay
API Model description of ServiceOverlay


{|class=wikitable
{|class=wikitable
Line 3,266: Line 3,412:
!Description
!Description
|-
|-
|attributes
| active
|Map&lt;String,double[]&gt;
| boolean
|
|  
|-
|-
|colorMultiplier
| attributes
|double
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|colorOffset
| calcTimeMS
|int
| long
|
|  
|-
|-
|customLegend
| colorMultiplier
|boolean
| double
|
|  
|-
|-
|id
| colorOffset
|int
| int
|
|  
|-
|-
|imageName
| crs
|String
| String
|
|  
|-
|-
|imageVersion
| customLegend
|int
| boolean
|
|  
|-
|-
|legend
| diffLegend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|maquetteOverride
| forceXY
|Map&lt;String,double[]&gt;
| boolean
|
|  
|-
|-
|name
| id
|String
| int
|
|  
|-
|-
|parentID
| imageName
|int
| String
|[[Overlay]] ID
|  
|-
|-
|sortIndex
| imageVersion
|int
| int
|
|  
|-
|-
|type
| inActiveCellSize
|OverlayType
| double
|
|  
|-
|-
|version
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|visible
| keys
|boolean
| Map&lt;String,String&gt;
|
|  
|}
|-
 
| layerName
==Api Model OverlayCategory==
| String
API Enumeration description of OverlayCategory
|
 
|-
{|class=wikitable
| layerNames
!Name
| String<nowiki>[]</nowiki>
!Description
|
|-
| 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
|
|-
|-
|ADMINISTRATIVE
| showDifference
|
| boolean
|  
|-
|-
|ENVIRONMENTAL
| sortIndex
|
| int
|  
|-
|-
|WATER
| sourceID
|
| int
| [[Source]] ID
|-
|-
|GRID_CALCULATION
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|GEO_DATA
| version
|
| int
|  
|-
|-
|TOPOGRAPHY
| visible
|
| boolean
|  
|-
|-
|NETWORKS
| warnings
|
| String
|  
|}
|}


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


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|OWNERSHIP
| active
|
| boolean
|  
|-
|-
|OWNERSHIP_GRID
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|ZIP_CODES
| calcInfo
|
| String
|  
|-
|-
|ZONING
| calcTimeMS
|
| long
|  
|-
|-
|NEIGHBORHOODS
| colorMultiplier
|
| double
|  
|-
|-
|MUNICIPALITIES
| colorOffset
|
| int
|  
|-
|-
|SCENARIO
| customLegend
|
| boolean
|  
|-
|-
|VACANCY
| diffLegend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|HEAT_STRESS
| id
|
| int
|  
|-
|-
|SHADOW
| imageName
|
| String
|  
|-
|-
|TRAFFIC_DENSITY
| imageVersion
|
| int
|  
|-
|-
|TRAFFIC_NO2
| inActiveCellSize
|
| double
|  
|-
|-
|TRAFFIC_NOISE
| inActiveTimeframes
|
| int
|  
|-
|-
|LIVABILITY
| keys
|
| Map&lt;String,String&gt;
|  
|-
|-
|AERIUS
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|RAINFALL
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|FLOODING
| maxValue
|
| float[]
|  
|-
|-
|GROUNDWATER
| minValue
|
| float[]
|  
|-
|-
|WATERSHED
| name
|
| String
|  
|-
|-
|SUBSIDENCE
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|WATERWIJZER
| prequels
|
| Map&lt;String,PrequelLink&gt;
|  
|-
|-
|AVG
| resultType
|
| String
|  
|-
|-
|COMBO
| showDifference
|
| boolean
|  
|-
|-
|DISTANCE
| sortIndex
|
| int
|  
|-
|-
|SIGHT_DISTANCE
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|TRAVEL_DISTANCE
| version
|
| int
|  
|-
|-
|INFERENCE
| visible
|
| boolean
|  
|-
|-
|ITERATION
| warnings
|
| String
|
|}
 
==Api Model SourceOverlay==
API Model description of SourceOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|GEO_TIFF
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|WMS
| colorMultiplier
|
| double
|  
|-
|-
|WCS
| colorOffset
|
| int
|  
|-
|-
|IMAGE
| customLegend
|
| boolean
|  
|-
|-
|AREA
| id
|
| int
|  
|-
|-
|ATTRIBUTE
| imageName
|
| String
|  
|-
|-
|FUNCTION
| imageVersion
|
| int
|  
|-
|-
|SATELLITE
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|HEIGHTMAP
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|UNDERGROUND
| name
|
| String
|  
|-
|-
|SOURCE
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|NETWORK_OWNERSHIP
| restColor
|
| TColor
| [[Color]]
|-
|-
|NETWORK_OVERVIEW
| sortIndex
|
| int
|  
|-
|-
|NETWORK_DISTANCE
| sources
|
| Map&lt;int,int&gt;
|  
|-
|-
|RESULT_CHILD
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|TEST
| version
|
| int
|  
|-
|-
|DISTURBANCE_DISTANCE
| visible
|
| boolean
|-
|  
|SAFETY_DISTANCE
|
|-
|DEPRECATED
|
|}
|}


==Api Model RainOverlay==
==Api Model TColor==
API Model description of RainOverlay
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model TensorLink==
API Model description of TensorLink


{|class=wikitable
{|class=wikitable
Line 3,513: Line 3,756:
!Description
!Description
|-
|-
|active
| coordinate
|boolean
| int[]
|
|  
|-
|-
|attributes
| id
|Map&lt;String,double[]&gt;
| int
|
|  
|-
|-
|calcInfo
| normalized
|String
| boolean
|
|  
|-
|-
|calcTimeMS
| prequel
|long
| String
|
|  
|-
| result
| String
|
|-
| tensorName
| String
|
|-
| valueType
| ValueType
|
|}
 
==Api Model TrafficDensityOverlay==
API Model description of TrafficDensityOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|colorMultiplier
| attributes
|double
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|colorOffset
| colorMultiplier
|int
| double
|
|  
|-
|-
|customLegend
| colorOffset
|boolean
| int
|
|  
|-
|-
|diffLegend
| customLegend
|LegendEntry<nowiki>[]</nowiki>
| boolean
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| legend
|double
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|inActiveTimeframes
| maquetteOverride
|int
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|keys
| name
|Map&lt;String,String&gt;
| String
|
|  
|-
|-
|legend
| parentID
|LegendEntry<nowiki>[]</nowiki>
| int
|
| [[Overlay]] ID
|-
|-
|maquetteOverride
| sortIndex
|Map&lt;String,double[]&gt;
| int
|
|  
|-
|-
|maxValue
| type
|float[]
| OverlayType
|
| [[Overlay Type]]
|-
|-
|minValue
| version
|float[]
| int
|
|  
|-
|-
|mode
| visible
|Mode
| boolean
|
|  
|}
 
==Api Model TrafficOverlay==
API Model description of TrafficOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|-
|name
| active
|String
| boolean
|
|  
|-
|-
|parentID
| attributes
|int
| Map&lt;String,double[]&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| calcTimeMS
|Map&lt;String,PrequelLink&gt;
| long
|
|  
|-
|-
|resultType
| colorMultiplier
|String
| double
|
|  
|-
|-
|showAreas
| colorOffset
|boolean
| int
|
|  
|-
|-
|showDifference
| customLegend
|boolean
| boolean
|
|  
|-
|-
|showSystem
| diffLegend
|boolean
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|sortIndex
| id
|int
| int
|
|  
|-
|-
|type
| imageName
|OverlayType
| String
|
|  
|-
|-
|version
| imageVersion
|int
| int
|
|  
|-
|-
|visible
| inActiveCellSize
|boolean
| double
|
|  
|-
|-
|warnings
| inActiveTimeframes
|String
| int
|
|  
|-
|-
|weatherID
| keys
|int
| Map&lt;String,String&gt;
|[[Weather]] ID
|
|}
|-
 
| legend
==Api Model Rasterization==
| LegendEntry<nowiki>[]</nowiki>
API Enumeration description of Rasterization
|
 
|-
{|class=wikitable
| maquetteOverride
!Name
| Map&lt;String,double[]&gt;
!Description
|
|-
| maxValue
| float[]
|
|-
| minValue
| float[]
|  
|-
| name
| String
|
|-
| parentID
| int
| [[Overlay]] ID
|-
|-
|FIRST
| prequels
|
| Map&lt;String,PrequelLink&gt;
|  
|-
|-
|MIN
| resultType
|
| String
|  
|-
|-
|MAX
| showDifference
|
| boolean
|  
|-
|-
|SINGLE_LAYER
| sortIndex
|
| int
|  
|-
|-
|GRID
| type
|
| OverlayType
|}
| [[Overlay Type]]
 
==Api Model RasterizationMethod==
API Enumeration description of RasterizationMethod
 
{|class=wikitable
!Name
!Description
|-
|-
|COMBINED
| version
|
| int
|  
|-
|-
|OUTLINE
| visible
|
| boolean
|  
|-
|-
|CENTER
| warnings
|
| String
|  
|}
|}


==Api Model RasterizationOverlay==
==Api Model TravelDistanceOverlay==
API Model description of RasterizationOverlay
API Model description of TravelDistanceOverlay


{|class=wikitable
{|class=wikitable
Line 3,690: Line 3,979:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|colorMultiplier
| colorMultiplier
|double
| double
|
|  
|-
|-
|colorOffset
| colorOffset
|int
| int
|
|  
|-
|-
|customLegend
| customLegend
|boolean
| boolean
|
|  
|-
|-
|diffLegend
| diffLegend
|LegendEntry<nowiki>[]</nowiki>
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|inActiveCellSize
| inActiveCellSize
|double
| double
|
|  
|-
|-
|inActiveTimeframes
| inActiveTimeframes
|int
| int
|
|  
|-
|-
|keys
| keys
|Map&lt;String,String&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|layerMapLink
| legend
|MapLink
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maquetteOverride
| maxValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| resultType
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|rasterization
| showDifference
|Rasterization
| boolean
|
|  
|-
|-
|resultType
| sortIndex
|String
| int
|
|  
|-
|-
|showDifference
| type
|boolean
| OverlayType
|
| [[Overlay Type]]
|-
|-
|sortIndex
| version
|int
| int
|
|  
|-
|-
|type
| visible
|OverlayType
| boolean
|
|  
|-
|-
|version
| warnings
|int
| String
|
|  
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
|}


==Api Model RasterizationPrequel==
==Api Model ValueType==
API Enumeration description of RasterizationPrequel
API Enumeration description of ValueType


{|class=wikitable
{|class=wikitable
Line 3,814: Line 4,095:
!Description
!Description
|-
|-
|INPUT
| DEFAULT
|
|
|-
| R
|
|-
| G
|
|-
| B
|
|-
| A
|  
|}
|}


==Api Model ResultChildOverlay==
==Api Model WCSOverlay==
API Model description of ResultChildOverlay
API Model description of WCSOverlay


{|class=wikitable
{|class=wikitable
Line 3,826: Line 4,119:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| calcTimeMS
| long
|
|-
| colorMultiplier
| double
|
|-
| colorOffset
| int
|
|-
| crs
| String
|  
|-
|-
|attributes
| customLegend
|Map&lt;String,double[]&gt;
| boolean
|
|  
|-
|-
|calcTimeMS
| diffLegend
|long
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|colorMultiplier
| forceXY
|double
| boolean
|
|  
|-
|-
|colorOffset
| id
|int
| int
|
|  
|-
|-
|customLegend
| imageName
|boolean
| String
|
|  
|-
|-
|diffLegend
| imageVersion
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|id
| inActiveCellSize
|int
| double
|
|  
|-
|-
|imageName
| inActiveTimeframes
|String
| int
|
|  
|-
|-
|imageVersion
| keys
|int
| Map&lt;String,String&gt;
|
|  
|-
|-
|inActiveCellSize
| layerName
|double
| String
|
|  
|-
|-
|inActiveTimeframes
| layerNames
|int
| String<nowiki>[]</nowiki>
|
|  
|-
|-
|keys
| legend
|Map&lt;String,String&gt;
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|legend
| maquetteOverride
|LegendEntry<nowiki>[]</nowiki>
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|maquetteOverride
| maxValue
|Map&lt;String,double[]&gt;
| float[]
|
|  
|-
|-
|maxValue
| minValue
|float[]
| float[]
|
|  
|-
|-
|minValue
| name
|float[]
| String
|
|  
|-
|-
|name
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|parentID
| prequels
|int
| Map&lt;String,PrequelLink&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| resultType
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|resultType
| showDifference
|String
| boolean
|
|  
|-
|-
|showDifference
| sortIndex
|boolean
| int
|
|  
|-
|-
|sortIndex
| sourceID
|int
| int
|
| [[Source]] ID
|-
|-
|type
| type
|OverlayType
| OverlayType
|
| [[Overlay Type]]
|-
|-
|version
| version
|int
| int
|
|  
|-
|-
|visible
| visible
|boolean
| boolean
|
|  
|-
|-
|warnings
| warnings
|String
| String
|
|  
|}
|}


==Api Model ResultParentOverlay==
==Api Model WMSOverlay==
API Model description of ResultParentOverlay
API Model description of WMSOverlay


{|class=wikitable
{|class=wikitable
Line 3,943: Line 4,256:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|calcTimeMS
| calcTimeMS
|long
| long
|
|  
|-
|-
|colorMultiplier
| colorMultiplier
|double
| double
|
|  
|-
|-
|colorOffset
| colorOffset
|int
| int
|
|  
|-
|-
|customLegend
| crs
|boolean
| String
|
|  
|-
|-
|diffLegend
| customLegend
|LegendEntry<nowiki>[]</nowiki>
| boolean
|
|  
|-
|-
|id
| diffLegend
|int
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageName
| forceXY
|String
| boolean
|
|  
|-
|-
|imageVersion
| id
|int
| int
|
|  
|-
|-
|inActiveCellSize
| imageName
|double
| String
|
|  
|-
|-
|inActiveTimeframes
| imageVersion
|int
| int
|
|  
|-
|-
|keys
| inActiveCellSize
|Map&lt;String,String&gt;
| double
|
|  
|-
|-
|legend
| inActiveTimeframes
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|maquetteOverride
| keys
|Map&lt;String,double[]&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|maxValue
| layerName
|float[]
| String
|
|  
|-
|-
|minValue
| layerNames
|float[]
| String<nowiki>[]</nowiki>
|
|  
|-
|-
|name
| legend
|String
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|parentID
| maquetteOverride
|int
| Map&lt;String,double[]&gt;
|[[Overlay]] ID
|  
|-
|-
|prequels
| maxValue
|Map&lt;String,PrequelLink&gt;
| float[]
|
|  
|-
|-
|resultType
| minValue
|String
| float[]
|
|  
|-
|-
|showDifference
| name
|boolean
| String
|
|  
|-
|-
|sortIndex
| parentID
|int
| int
|
| [[Overlay]] ID
|-
|-
|type
| prequels
|OverlayType
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|-
|version
| resultType
|int
| String
|
|  
|-
|-
|visible
| showDifference
|boolean
| boolean
|
|  
|-
|-
|warnings
| sortIndex
|String
| int
|
|  
|}
|-
 
| sourceID
==Api Model SWRC==
| int
API Enumeration description of SWRC
| [[Source]] ID
 
|-
{|class=wikitable
| type
!Name
| OverlayType
!Description
| [[Overlay Type]]
|-
| version
| int
|
|-
|-
|NONE
| visible
|
| boolean
|  
|-
|-
|VAN_GENUCHTEN
| warnings
|
| String
|  
|}
|}


==Api Model SatelliteOverlay==
==Api Model WaterOverlay==
API Model description of SatelliteOverlay
API Model description of WaterOverlay


{|class=wikitable
{|class=wikitable
Line 4,074: Line 4,393:
!Description
!Description
|-
|-
|active
| active
|boolean
| 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 Scope==
API Enumeration description of Scope
 
{|class=wikitable
!Name
!Description
|-
|MAP
|
|-
|WATER_AREAS
|
|-
|LIMIT_AREAS
|
|-
|OVERRIDE_RAIN_AREAS
|
|}
 
==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 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 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 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 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 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 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
| attributes
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|GROUND_LAST_UNSATURATED_FRACTION
| calcInfo
|
| String
|  
|-
|-
|GROUND_TRANSPIRATION
| calcTimeMS
|
| long
|  
|-
|-
|GROUND_LAST_TRANSPIRATION
| colorMultiplier
|
| double
|  
|-
|-
|SEWER_LAST_VALUE
| colorOffset
|
| int
|  
|-
|-
|SEWER_MAX_VALUE
| customLegend
|
| boolean
|  
|-
|-
|LAST_EVAPORATED
| diffLegend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|LAST_EVAPOTRANSPIRATION
| id
|
| int
|  
|-
|-
|EVAPORATED
| imageName
|
| String
|  
|-
|-
|EVAPOTRANSPIRATION
| imageVersion
|
| int
|  
|-
|-
|IMPACTED_BUILDINGS
| inActiveCellSize
|
| double
|  
|-
|-
|TRACER_A
| inActiveTimeframes
|
| int
|  
|-
|-
|TRACER_B
| keys
|
| Map&lt;String,String&gt;
|  
|-
|-
|TRACER_C
| legend
|
| LegendEntry<nowiki>[]</nowiki>
|  
|-
|-
|TRACER_D
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|BASE_TYPES
| maxValue
|
| float[]
|  
|-
|-
|SURFACE_DIFFERENCE
| minValue
|
| float[]
|  
|-
|-
|DEBUG_UV
| mode
|
| Mode
|  
|-
|-
|GPU_OVERVIEW
| name
|
| String
|  
|-
|-
|DEBUG_AVG_AREAS
| parentID
|
| int
| [[Overlay]] ID
|-
|-
|DEBUG_UV_DIRECTION
| prequels
|
| Map&lt;String,PrequelLink&gt;
|  
|-
|-
|DEBUG_WATERWAYS
| resultType
|
| String
|  
|-
|-
|SURFACE_LAST_U
| showAreas
|
| boolean
|  
|-
|-
|SURFACE_LAST_V
| showDifference
|
| boolean
|}
|  
 
==Api Model WaterSystem==
API Enumeration description of WaterSystem
 
{|class=wikitable
!Name
!Description
|-
|-
|OBJECTS
| showSystem
|
| boolean
|  
|-
|-
|AREAS
| sortIndex
|
| int
|}
|  
 
==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
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|DISCHARGE_REMAINING_WATER
| version
|
| int
|  
|-
|-
|CULVERT_FLOW_DIRECTION
| visible
|
| boolean
|  
|-
|-
|MIN_AREA
| warnings
|
| String
|  
|-
|-
|LIMIT_ROAD
| weatherID
|
| int
| [[Weather]] ID
|}
|}


Line 6,622: Line 4,530:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|calcTimeMS
|long
|
|-
|-
|colorMultiplier
| attributes
|double
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|colorOffset
| calcTimeMS
|int
| long
|
|  
|-
|-
|customLegend
| colorMultiplier
|boolean
| double
|
|  
|-
|-
|diffLegend
| colorOffset
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|id
| customLegend
|int
| boolean
|
|  
|-
|-
|imageName
| diffLegend
|String
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|imageVersion
| id
|int
| int
|
|  
|-
|-
|inActiveCellSize
| imageName
|double
| String
|
|  
|-
|-
|inActiveTimeframes
| imageVersion
|int
| int
|
|  
|-
|-
|keys
| inActiveCellSize
|Map&lt;String,String&gt;
| double
|
|  
|-
|-
|legend
| inActiveTimeframes
|LegendEntry<nowiki>[]</nowiki>
| int
|
|  
|-
|-
|maquetteOverride
| keys
|Map&lt;String,double[]&gt;
| Map&lt;String,String&gt;
|
|  
|-
|-
|maxValue
| legend
|float[]
| LegendEntry<nowiki>[]</nowiki>
|
|  
|-
|-
|method
| maquetteOverride
|DischargeMethod
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|minValue
| maxValue
|float[]
| float[]
|
|  
|-
|-
|name
| method
|String
| DischargeMethod
|
|  
|-
|-
|parentID
| minValue
|int
| float[]
|[[Overlay]] ID
|  
|-
|-
|prequels
| name
|Map&lt;String,PrequelLink&gt;
| String
|
|  
|-
|-
|resultType
| parentID
|String
| int
|
| [[Overlay]] ID
|-
|-
|showDifference
| prequels
|boolean
| Map&lt;String,PrequelLink&gt;
|
|  
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|-
|warnings
|String
|
|}
 
==Api Model WatershedPrequel==
API Enumeration description of WatershedPrequel
 
{|class=wikitable
!Name
!Description
|-
|-
|DIRECTION
| resultType
|
| String
|}
|  
 
==Api Model WatershedResult==
API Enumeration description of WatershedResult
 
{|class=wikitable
!Name
!Description
|-
|-
|WATERSHEDS
| showDifference
|
| boolean
|  
|-
|-
|DISCHARGE_AREAS
| sortIndex
|
| int
|  
|-
|-
|DIRECTION
| type
|
| OverlayType
| [[Overlay Type]]
|-
|-
|BASE_TYPES
| version
|
| int
|}
|  
 
==Api Model ZoneDistanceAttribute==
API Enumeration description of ZoneDistanceAttribute
 
{|class=wikitable
!Name
!Description
|-
|-
|ATTRIBUTE_TIMEFRAMES
| visible
|
| boolean
|  
|-
|-
|HIT_COUNT
| warnings
|
| String
|  
|}
|}


Line 6,785: Line 4,648:


[[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