Api session items overlays

From Tygron Support wiki
Revision as of 12:43, 20 April 2026 by Frank@tygron.nl (talk | contribs)
Jump to navigation Jump to search

Api session items Overlay Endpoints.

Edit items with event: editoroverlay.

Default Query: 

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

Example Response: 

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

Limit Queries

version=100: 

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

Show Queries

max version: 

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

size: 

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

Overlays (GeoJSON): 

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

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model AeriusOverlay

API Model description of AeriusOverlay

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

Api Model AreaOverlay

API Model description of AreaOverlay

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

Api Model AttributeKey

API Enumeration description of AttributeKey

Name Description
A
B
C
D
E
F
G
H
I
J

Api Model AttributeOverlay

API Model description of AttributeOverlay

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

Api Model AttributeOverlayPredicate

API Model description of AttributeOverlayPredicate

Name Type Description
attribute String
mapLink MapLink

Api Model AvgModelAttribute

API Enumeration description of AvgModelAttribute

Name Description
DISTANCE_M
ATTRIBUTE_TIMEFRAMES
DEFAULT_VALUE
SURFACE_ONLY

Api Model AvgOverlay

API Model description of AvgOverlay

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

Api Model BridgeElevation

API Enumeration description of BridgeElevation

Name Description
LOWEST
TERRAIN
BRIDGE

Api Model ClimateModel

API Model description of ClimateModel

Name Type Description
endTemp double
endYear int
oxidation double
soilTempFactor double
startTemp double
startYear int

Api Model ComboModelAttribute

API Enumeration description of ComboModelAttribute

Name Description
ATTRIBUTE_DEFAULT_VALUE
ATTRIBUTE_SURFACE_ONLY

Api Model ComboOverlay

API Model description of ComboOverlay

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

Api Model DefaultAttribute

API Enumeration description of DefaultAttribute

Name Description
ATTRIBUTE

Api Model DefaultOverlay

API Model description of DefaultOverlay

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

Api Model DefaultRasterizationOverlay

API Model description of DefaultRasterizationOverlay

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

Api Model DefaultResult

API Enumeration description of DefaultResult

Name Description
DEFAULT

Api Model DischargeMethod

API Enumeration description of DischargeMethod

Name Description
HEIGHT_MINIMA
WATER_TERRAINS
AREAS

Api Model DistanceOverlay

API Model description of DistanceOverlay

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

Api Model DistanceResult

API Enumeration description of DistanceResult

Name Description
ZONE
SIGHT

Api Model FloodingOverlay

API Model description of FloodingOverlay

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

Api Model FunctionOverlay

API Model description of FunctionOverlay

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

Api Model GasType

API Enumeration description of GasType

Name Description
NOX
NO2

Api Model GeoTiffAttribute

API Enumeration description of GeoTiffAttribute

Name Description
BAND

Api Model GeoTiffOverlay

API Model description of GeoTiffOverlay

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

Api Model GeoTiffResult

API Enumeration description of GeoTiffResult

Name Description
NEAREST
INTERPOLATED

Api Model GridModelAttribute

API Enumeration description of GridModelAttribute

Name Description
ITERATION_ACTIVE
SKIP_NO_DATA
GPU_CLUSTER_INDEX

Api Model GridOverlay

API Model description of GridOverlay

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

Api Model GroundwaterOverlay

API Model description of GroundwaterOverlay

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

Api Model HeatDpraAttribute

API Enumeration description of HeatDpraAttribute

Name Description
DATES
DAILY_AVG_RADIATION
DAILY_TEMPERATURE_MAX
DAILY_TEMPERATURE_MIN
EXCLUDE_BUILDINGS
EXCLUDE_WATER
EXCLUDE_FOLIAGE_HEIGHT_M
FOLIAGE_AREAS
HOURLY_RADIATION
HOURLY_TEMPERATURE
HOURLY_HUMIDITY
SUN_ALTITUDE
SUN_AZIMUTH
SUN_DAILY_MOTION
WIND_DIRECTION
WIND_SPEED
DAILY_AVG_WIND_SPEED
MAX_SHADOW_DISTANCE
MAX_TRUNK_DISTANCE
WIND_DECLINE_ANGLE

Api Model HeatKey

API Enumeration description of HeatKey

Name Description
FOLIAGE_HEIGHT

Api Model HeatModel

API Enumeration description of HeatModel

Name Description
UNESCO
DPRA

Api Model HeatOverlay

API Model description of HeatOverlay

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

Api Model HeatPrequel

API Enumeration description of HeatPrequel

Name Description
FOLIAGE_HEIGHT
BUILDING_ELEVATION
TERRAIN_ELEVATION

Api Model HeatResult

API Enumeration description of HeatResult

Name Description
BOWEN_RATIO
FOLIAGE
PET
PET_RELATIVE
SHADE
SKY_VIEW
SKY_VIEW_AVG
TEMPERATURE_ATMOSPHERE
UHI
VEGETATION
VEGETATION_AVG
WIND_SPEED

Api Model HeightAttribute

API Enumeration description of HeightAttribute

Name Description
ZONING_PERMIT_REQUIRED

Api Model HeightOverlay

API Model description of HeightOverlay

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

Api Model HeightResult

API Enumeration description of HeightResult

Name Description
DSM
DTM
FLOORS

Api Model ImageAttribute

API Enumeration description of ImageAttribute

Name Description
ALPHA

Api Model ImageOverlay

API Model description of ImageOverlay

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

Api Model InferenceAttribute

API Enumeration description of InferenceAttribute

Name Description
MASK_THRESHOLD
SCORE_THRESHOLD
INFERENCE_MODE
STRIDE_FRACTION
BOX_OVERLAP
PRIORITIZE_LABELS
GPU_MEMORY_MB

Api Model InferenceMode

API Enumeration description of InferenceMode

Name Description
CLASSIFICATION
BBOX_DETECTION

Api Model InferenceOverlay

API Model description of InferenceOverlay

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

Api Model InferencePrequel

API Enumeration description of InferencePrequel

Name Description
A
B
C

Api Model InferenceResult

API Enumeration description of InferenceResult

Name Description
LABELS
SCORES
BOXES
MASKS
DEBUG_GT_INSTANCES
CENTER_POINTS

Api Model Input

API Enumeration description of Input

Name Description
A
B
C
D
E
F
G
H
I
J

Api Model IterationAttribute

API Enumeration description of IterationAttribute

Name Description
MODULUS
TIMEFRAME_TIMES

Api Model IterationOverlay

API Model description of IterationOverlay

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

Api Model IterationPrequel

API Enumeration description of IterationPrequel

Name Description
ITERATION

Api Model MinMax

API Enumeration description of MinMax

Name Description
NEVER
LARGE_CELL
ALWAYS

Api Model Mode

API Enumeration description of Mode

Name Description
SPEED
AVERAGE
ACCURACY

Api Model NO2Overlay

API Model description of NO2Overlay

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

Api Model NO2Result

API Enumeration description of NO2Result

Name Description
CONCENTRATION
EMISSION_NO2
EMISSION_NOX
TREEFACTOR
TREES

Api Model NetOverlay

API Model description of NetOverlay

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

Api Model NoPrequel

API Enumeration description of NoPrequel

Name Description

Api Model NoiseOverlay

API Model description of NoiseOverlay

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

Api Model NoiseResult

API Enumeration description of NoiseResult

Name Description
NOISE_DB
EMISSION

Api Model Operator (AvgOverlay)

API Enumeration description of Operator

Name Description
AVG
AVG_INTERPOLATED
MAX
MIN

Api Model Operator (ComboOverlay)

API Enumeration description of Operator

Name Description
SIN
COS
TAN
ASIN
ACOS
ATAN
SQRT
ROUND
FLOOR
CEIL
ABS
EXP
LN
LOG
RANDOM
ERF
GTE
GT
LTE
LT
NEQ
EQ
IF
AND
OR
SWITCH
ADD
MUL
DIV
SUB
MAX
MIN
AVG
POW
PERCENTILE
AVG_GTE_PERCENTILE
AVG_LTE_PERCENTILE
COLOR
RED
GREEN
BLUE
ALPHA

Api Model Overlay

API Model description of Overlay

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

Api Model OverlayCategory

API Enumeration description of OverlayCategory

Name Description
ADMINISTRATIVE
ENVIRONMENTAL
WATER
GRID_CALCULATION
GEO_DATA
TOPOGRAPHY
NETWORKS

Api Model OverlayType

API Enumeration description of OverlayType

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

Api Model RainOverlay

API Model description of RainOverlay

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

Api Model Rasterization

API Enumeration description of Rasterization

Name Description
FIRST
MIN
MAX
SINGLE_LAYER
GRID

Api Model RasterizationMethod

API Enumeration description of RasterizationMethod

Name Description
COMBINED
OUTLINE
CENTER

Api Model RasterizationOverlay

API Model description of RasterizationOverlay

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

Api Model RasterizationPrequel

API Enumeration description of RasterizationPrequel

Name Description
INPUT

Api Model ResultChildOverlay

API Model description of ResultChildOverlay

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

Api Model ResultParentOverlay

API Model description of ResultParentOverlay

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

Api Model SWRC

API Enumeration description of SWRC

Name Description
NONE
VAN_GENUCHTEN

Api Model SatelliteOverlay

API Model description of SatelliteOverlay

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

Api Model Scope

API Enumeration description of Scope

Name Description
MAP
WATER_AREAS
LIMIT_AREAS
OVERRIDE_RAIN_AREAS

Api Model ServiceOverlay

API Model description of ServiceOverlay

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

Api Model ShadowAttribute

API Enumeration description of ShadowAttribute

Name Description
DATES
SUN_ALTITUDE
SUN_AZIMUTH
MAX_SHADOW_DISTANCE
MAX_FOLIAGE_RADIUS

Api Model ShadowOverlay

API Model description of ShadowOverlay

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

Api Model ShadowPrequel

API Enumeration description of ShadowPrequel

Name Description
FOLIAGE_HEIGHT
BUILDING_ELEVATION
TERRAIN_ELEVATION

Api Model ShadowResult

API Enumeration description of ShadowResult

Name Description
SHADE
FOLIAGE

Api Model Shoreline

API Enumeration description of Shoreline

Name Description
NONE
ONE_CELL
TWO_CELLS

Api Model SightDistanceAttribute

API Enumeration description of SightDistanceAttribute

Name Description
SOURCE_HEIGHT_M
OBSERVER_HEIGHT_M
ATTRIBUTE_TIMEFRAMES

Api Model SourceOverlay

API Model description of SourceOverlay

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

Api Model Style

API Enumeration description of Style

Name Description
INTERPOLATED
NEAREST
ARROW
COLOR
FLOAT32
DIFFERENCE

Api Model SubsidenceAttribute

API Enumeration description of SubsidenceAttribute

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

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

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

Api Model SubsidencePrequel

API Enumeration description of SubsidencePrequel

Name Description
LOW_GROUND_WATER
HIGH_GROUND_WATER
CLAY_THICKNESS

Api Model SubsidenceResult

API Enumeration description of SubsidenceResult

Name Description
SUBSIDENCE
OXIDATION
SETTLEMENT
LOW_GROUND_WATER
HI_GROUND_WATER

Api Model SurfaceMode

API Enumeration description of SurfaceMode

Name Description
NONE
SHALLOW
AVG_WATERWAY
HYBRID
AVG_TERRAIN

Api Model TrafficAttribute

API Enumeration description of TrafficAttribute

Name Description
HOURS
CARS_ACTIVE
VANS_ACTIVE
TRUCKS_ACTIVE
BUSES_ACTIVE

Api Model TrafficDensityOverlay

API Model description of TrafficDensityOverlay

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

Api Model TrafficNO2Attribute

API Enumeration description of TrafficNO2Attribute

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

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

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

Api Model TravelDistanceAttribute

API Enumeration description of TravelDistanceAttribute

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

Name Description
DESTINATION_AREA
BLOCKED

Api Model TravelDistanceOverlay

API Model description of TravelDistanceOverlay

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

Api Model TravelDistancePrequel

API Enumeration description of TravelDistancePrequel

Name Description
TRAVERSABLE
BLOCKING
DESTINATION

Api Model TravelDistanceResult

API Enumeration description of TravelDistanceResult

Name Description
DESTINATIONS
BASE_TYPES

Api Model WCSOverlay

API Model description of WCSOverlay

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

Api Model WCSResult

API Enumeration description of WCSResult

Name Description
NEAREST
INTERPOLATED

Api Model WMSOverlay

API Model description of WMSOverlay

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

Api Model WMSResult

API Enumeration description of WMSResult

Name Description
COLOR
FLOAT32
RED
GREEN
BLUE
ALPHA

Api Model WWOverlay

API Model description of WWOverlay

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

Api Model WaterKey

API Enumeration description of WaterKey

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

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

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

Api Model WaterPrequel

API Enumeration description of WaterPrequel

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

Name Description
WATER_STRESS
SURFACE_LAST_DIRECTION
SURFACE_AVG_DIRECTION
SURFACE_DURATION
SURFACE_ELEVATION
SURFACE_FLOW
SURFACE_LAST_FLOW
SURFACE_LAST_SPEED
SURFACE_LAST_VALUE
SURFACE_LAST_DATUM
SURFACE_MAX_SPEED
SURFACE_MAX_VALUE
SURFACE_EVAPORATION
SURFACE_LAST_EVAPORATION
BUILDING_LAST_STORAGE
FLOOD_ARRIVAL_TIME
FLOOD_RISE_RATE
LAST_RAIN
RAIN
GROUND_LAST_STORAGE
GROUND_LAST_VALUE
GROUND_LAST_DIRECTION
GROUND_FLOW
GROUND_MAX_STORAGE
GROUND_MAX_VALUE
GROUND_WATERTABLE
GROUND_BOTTOM_FLOW
GROUND_LAST_UNSATURATED_STORAGE
GROUND_LAST_UNSATURATED_FRACTION
GROUND_TRANSPIRATION
GROUND_LAST_TRANSPIRATION
SEWER_LAST_VALUE
SEWER_MAX_VALUE
LAST_EVAPORATED
LAST_EVAPOTRANSPIRATION
EVAPORATED
EVAPOTRANSPIRATION
IMPACTED_BUILDINGS
TRACER_A
TRACER_B
TRACER_C
TRACER_D
BASE_TYPES
SURFACE_DIFFERENCE
DEBUG_UV
GPU_OVERVIEW
DEBUG_AVG_AREAS
DEBUG_UV_DIRECTION
DEBUG_WATERWAYS
SURFACE_LAST_U
SURFACE_LAST_V

Api Model WaterSystem

API Enumeration description of WaterSystem

Name Description
OBJECTS
AREAS

Api Model WatershedKey

API Enumeration description of WatershedKey

Name Description
DISCHARGE_AREA

Api Model WatershedModelAttribute

API Enumeration description of WatershedModelAttribute

Name Description
FILL_DISTANCE
DISCHARGE_REMAINING_WATER
CULVERT_FLOW_DIRECTION
MIN_AREA
LIMIT_ROAD

Api Model WatershedOverlay

API Model description of WatershedOverlay

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

Api Model WatershedPrequel

API Enumeration description of WatershedPrequel

Name Description
DIRECTION

Api Model WatershedResult

API Enumeration description of WatershedResult

Name Description
WATERSHEDS
DISCHARGE_AREAS
DIRECTION
BASE_TYPES

Api Model ZoneDistanceAttribute

API Enumeration description of ZoneDistanceAttribute

Name Description
ATTRIBUTE_TIMEFRAMES
HIT_COUNT

See also

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