Api session items overlays: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
43,073 edits
No edit summary
No edit summary
Line 212: Line 212:
| areaIDs
| areaIDs
| int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
| [[Area]]s ID  
| [[[[Area]]]]s ID  
|-
|-
| attributes
| attributes
Line 256: Line 256:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| remainderColor
| remainderColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| sortIndex
| sortIndex
Line 268: Line 268:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 293: Line 293:
| attributeColor
| attributeColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| attributes
| attributes
Line 333: Line 333:
| mapLink
| mapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| maquetteOverride
| maquetteOverride
Line 345: Line 345:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| restColor
| restColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| sortIndex
| sortIndex
Line 357: Line 357:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 430: Line 430:
| layerMapLink
| layerMapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| legend
| legend
Line 454: Line 454:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 478: Line 478:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 559: Line 559:
| layerMapLink
| layerMapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| legend
| legend
Line 583: Line 583:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 607: Line 607:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 704: Line 704:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 724: Line 724:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 801: Line 801:
| layerMapLink
| layerMapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| legend
| legend
Line 825: Line 825:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 849: Line 849:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 943: Line 943:
| layerMapLink
| layerMapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| legend
| legend
Line 967: Line 967:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 991: Line 991:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,096: Line 1,096:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,124: Line 1,124:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,140: Line 1,140:
| weatherID
| weatherID
| int
| int
| [[Weather]] ID  
| [[[[Weather]]]] ID  
|}
|}


Line 1,169: Line 1,169:
| functionIDs
| functionIDs
| int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
| [[Function]]s ID  
| [[[[Function]]]]s ID  
|-
|-
| functionsColor
| functionsColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| id
| id
Line 1,201: Line 1,201:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| remainderColor
| remainderColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| sortIndex
| sortIndex
Line 1,213: Line 1,213:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,262: Line 1,262:
| geoTiffIDs
| geoTiffIDs
| int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
| [[GeoTIFF|Geo Tiffs]] ID  
| [[[[GeoTIFF]]|[[GeoTIFF|Geo Tiffs]]]] ID  
|-
|-
| id
| id
Line 1,310: Line 1,310:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,330: Line 1,330:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,427: Line 1,427:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,447: Line 1,447:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,552: Line 1,552:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,580: Line 1,580:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,596: Line 1,596:
| weatherID
| weatherID
| int
| int
| [[Weather]] ID  
| [[[[Weather]]]] ID  
|}
|}


Line 1,703: Line 1,703:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,723: Line 1,723:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,820: Line 1,820:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 1,840: Line 1,840:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 1,909: Line 1,909:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| sortIndex
| sortIndex
Line 1,917: Line 1,917:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,010: Line 2,010:
| neuralNetworkID
| neuralNetworkID
| int
| int
| [[Neural Network]] ID  
| [[[[Neural Network]]]] ID  
|-
|-
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 2,038: Line 2,038:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,135: Line 2,135:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 2,155: Line 2,155:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,180: Line 2,180:
| color
| color
| TColor
| TColor
|  
| [[Color]]
|-
|-
| entryName
| entryName
Line 2,294: Line 2,294:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 2,314: Line 2,314:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,379: Line 2,379:
| netType
| netType
| NetType
| NetType
|  
| [[Net Type]]
|-
|-
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| showActive
| showActive
Line 2,399: Line 2,399:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,515: Line 2,515:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 2,535: Line 2,535:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,600: Line 2,600:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| sortIndex
| sortIndex
Line 2,608: Line 2,608:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,858: Line 2,858:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 2,886: Line 2,886:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 2,902: Line 2,902:
| weatherID
| weatherID
| int
| int
| [[Weather]] ID  
| [[[[Weather]]]] ID  
|}
|}


Line 2,990: Line 2,990:
| layerMapLink
| layerMapLink
| MapLink
| MapLink
|  
| [[Maplink]]
|-
|-
| legend
| legend
Line 3,014: Line 3,014:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,038: Line 3,038:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,135: Line 3,135:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,155: Line 3,155:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,252: Line 3,252:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,272: Line 3,272:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,369: Line 3,369:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,389: Line 3,389:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,502: Line 3,502:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,522: Line 3,522:
| sourceID
| sourceID
| int
| int
| [[Source]] ID  
| [[[[Source]]]] ID  
|-
|-
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,627: Line 3,627:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,647: Line 3,647:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,712: Line 3,712:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| restColor
| restColor
| TColor
| TColor
|  
| [[Color]]
|-
|-
| sortIndex
| sortIndex
Line 3,728: Line 3,728:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,835: Line 3,835:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| sortIndex
| sortIndex
Line 3,843: Line 3,843:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 3,936: Line 3,936:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 3,956: Line 3,956:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 4,053: Line 4,053:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 4,073: Line 4,073:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 4,209: Line 4,209:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 4,229: Line 4,229:
| sourceID
| sourceID
| int
| int
| [[Source]] ID  
| [[[[Source]]]] ID  
|-
|-
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 4,346: Line 4,346:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 4,366: Line 4,366:
| sourceID
| sourceID
| int
| int
| [[Source]] ID  
| [[[[Source]]]] ID  
|-
|-
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 4,475: Line 4,475:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 4,503: Line 4,503:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version
Line 4,519: Line 4,519:
| weatherID
| weatherID
| int
| int
| [[Weather]] ID  
| [[[[Weather]]]] ID  
|}
|}


Line 4,608: Line 4,608:
| parentID
| parentID
| int
| int
| [[Overlay]] ID  
| [[[[Overlay]]]] ID  
|-
|-
| prequels
| prequels
Line 4,628: Line 4,628:
| type
| type
| OverlayType
| OverlayType
|  
| [[Overlay Type]]
|-
|-
| version
| version

Revision as of 12:57, 8 June 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" : 8,
  "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" : 55,
  "visible" : true,
  "warnings" : ""
} ]

Limit Queries

version=100: 

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

Show Queries

max version: 

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

size: 

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

Overlays (GeoJSON): 

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

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model AreaOverlay

API Model description of AreaOverlay

Name Type Description
areaIDs int[] [[Area]]s 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[] [[Function]]s 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[] [[GeoTIFF|Geo Tiffs]] ID
id int
imageName String
imageVersion int
inActiveCellSize double
inActiveTimeframes int
keys Map<String,String>
legend LegendEntry[]
maquetteOverride Map<String,double[]>
maxValue float[]
minValue float[]
name String
parentID int [[Overlay]] ID
prequels Map<String,PrequelLink>
resultType String
showDifference boolean
sortIndex int
type OverlayType Overlay Type
version int
visible boolean
warnings String

Api Model GridOverlay

API Model description of GridOverlay

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

Api Model GroundwaterOverlay

API Model description of GroundwaterOverlay

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

Api Model HeatModel

API Enumeration description of HeatModel

Name Description
UNESCO
DPRA

Api Model HeatOverlay

API Model description of HeatOverlay

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

Api Model HeightOverlay

API Model description of HeightOverlay

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

Api Model ImageOverlay

API Model description of ImageOverlay

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

Api Model InferenceOverlay

API Model description of InferenceOverlay

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

Api Model IterationOverlay

API Model description of IterationOverlay

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

Api Model LegendEntry

API Model description of LegendEntry

Name Type Description
color TColor Color
entryName String
id int
value float

Api Model Mode

API Enumeration description of Mode

Name Description
SPEED
AVERAGE
ACCURACY

Api Model NO2Overlay

API Model description of NO2Overlay

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

Api Model NetOverlay

API Model description of NetOverlay

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

Api Model NetType

API Enumeration description of NetType

Name Description
ELECTRICITY
GAS
HEAT
INTERNET
SEWER

Api Model NoiseOverlay

API Model description of NoiseOverlay

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

Api Model Overlay

API Model description of Overlay

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

Api Model OverlayType

API Enumeration description of OverlayType

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

Api Model RainOverlay

API Model description of RainOverlay

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

Api Model Rasterization

API Enumeration description of Rasterization

Name Description
FIRST
MIN
MAX
SINGLE_LAYER
GRID

Api Model RasterizationOverlay

API Model description of RasterizationOverlay

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

Api Model ResultChildOverlay

API Model description of ResultChildOverlay

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

Api Model ResultParentOverlay

API Model description of ResultParentOverlay

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

Api Model SatelliteOverlay

API Model description of SatelliteOverlay

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

Api Model ServiceOverlay

API Model description of ServiceOverlay

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

Api Model ShadowOverlay

API Model description of ShadowOverlay

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

Api Model SourceOverlay

API Model description of SourceOverlay

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

Api Model TColor

API Model description of TColor

Name Type Description

API Model description of TensorLink

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

Api Model TrafficDensityOverlay

API Model description of TrafficDensityOverlay

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

Api Model TrafficOverlay

API Model description of TrafficOverlay

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

Api Model TravelDistanceOverlay

API Model description of TravelDistanceOverlay

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

Api Model ValueType

API Enumeration description of ValueType

Name Description
DEFAULT
R
G
B
A

Api Model WCSOverlay

API Model description of WCSOverlay

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

Api Model WMSOverlay

API Model description of WMSOverlay

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

Api Model WaterOverlay

API Model description of WaterOverlay

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

Api Model WatershedOverlay

API Model description of WatershedOverlay

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

See also

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