Api session event editor measure: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
!Description
!Description
|-
|-
|[[api session event editor measure add|ADD]]
|[[Api session event editor measure add|ADD]]
|Add [[Measure]] for [[Stakeholder]]
|Add [[Measure]] for [[Stakeholder]]
|-
|-
|[[api session event editor measure duplicate|DUPLICATE]]
|[[Api session event editor measure duplicate|DUPLICATE]]
|Duplicate specified [[Measure]].
|Duplicate specified [[Measure]].
|-
|-
|[[api session event editor measure remove|REMOVE]]
|[[Api session event editor measure remove|REMOVE]]
|Remove specified [[Measure]].
|Remove specified [[Measure]].
|-
|-
|[[api session event editor measure set name|SET_NAME]]
|[[Api session event editor measure set name|SET_NAME]]
|Set the name of a [[Measure]].
|Set the name of a [[Measure]].
|}
|}
Line 24: Line 24:
!Description
!Description
|-
|-
|[[api session event editor measure add building|ADD_BUILDING]]
|[[Api session event editor measure add building|ADD_BUILDING]]
|Add a new [[Building]] to specified [[Measure]]
|Add a new [[Building]] to specified [[Measure]]
|-
|-
|[[api session event editor measure add event|ADD_EVENT]]
|[[Api session event editor measure add event|ADD_EVENT]]
|Add a new event to a [[Measure]] for a specific [[Action]] Type.
|Add a new event to a [[Measure]] for a specific [[Action]] Type.
|-
|-
|[[api session event editor measure add geotiff|ADD_GEOTIFF]]
|[[Api session event editor measure add geotiff|ADD_GEOTIFF]]
|Add a new [[GeoTIFF]] Spatial to a [[Measure]].
|Add a new [[GeoTIFF]] Spatial to a [[Measure]].
|-
|-
|[[api session event editor measure add geotiff polygons|ADD_GEOTIFF_POLYGONS]]
|[[Api session event editor measure add geotiff polygons|ADD_GEOTIFF_POLYGONS]]
|Add polygons to existing polygons of a [[GeoTIFF]] Spatial of a [[Measure]].
|Add polygons to existing polygons of a [[GeoTIFF]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure add grid|ADD_GRID]]
|[[Api session event editor measure add grid|ADD_GRID]]
|Add a new Grid Spatial to a [[Measure]].
|Add a new Grid Spatial to a [[Measure]].
|-
|-
|[[api session event editor measure add grid polygons|ADD_GRID_POLYGONS]]
|[[Api session event editor measure add grid polygons|ADD_GRID_POLYGONS]]
|Add polygons to existing polygons of a Grid Spatial of a [[Measure]].
|Add polygons to existing polygons of a Grid Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure add levee|ADD_LEVEE]]
|[[Api session event editor measure add levee|ADD_LEVEE]]
|Add a new [[Levee]] Spatial of a specified [[Levee]] to a [[Measure]].
|Add a new [[Levee]] Spatial of a specified [[Levee]] to a [[Measure]].
|-
|-
|[[api session event editor measure add levee polygons|ADD_LEVEE_POLYGONS]]
|[[Api session event editor measure add levee polygons|ADD_LEVEE_POLYGONS]]
|Add polygons to existing outer (or inner) polygons of a [[Levee]] Spatial of a [[Measure]].
|Add polygons to existing outer (or inner) polygons of a [[Levee]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure add terrain|ADD_TERRAIN]]
|[[Api session event editor measure add terrain|ADD_TERRAIN]]
|Add a new [[Terrain]] Spatial to a [[Measure]].
|Add a new [[Terrain]] Spatial to a [[Measure]].
|-
|-
|[[api session event editor measure add terrain polygons|ADD_TERRAIN_POLYGONS]]
|[[Api session event editor measure add terrain polygons|ADD_TERRAIN_POLYGONS]]
|Add polygons to existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]].
|Add polygons to existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure add upgrade|ADD_UPGRADE]]
|[[Api session event editor measure add upgrade|ADD_UPGRADE]]
|Add a new Upgrade Spatial to a [[Measure]].
|Add a new Upgrade Spatial to a [[Measure]].
|-
|-
|[[api session event editor measure add upgrade polygons|ADD_UPGRADE_POLYGONS]]
|[[Api session event editor measure add upgrade polygons|ADD_UPGRADE_POLYGONS]]
|Add polygons to existing polygons of an Upgrade Spatial of a [[Measure]].
|Add polygons to existing polygons of an Upgrade Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure duplicate building|DUPLICATE_BUILDING]]
|[[Api session event editor measure duplicate building|DUPLICATE_BUILDING]]
|Duplicate specified [[Measure]] [[Building]].
|Duplicate specified [[Measure]] [[Building]].
|-
|-
|[[api session event editor measure import buildings|IMPORT_BUILDINGS]]
|[[Api session event editor measure import buildings|IMPORT_BUILDINGS]]
|Import [[Measure]] [[Building]] Collection
|Import [[Measure]] [[Building]] Collection
|-
|-
|[[api session event editor measure import geotiffs|IMPORT_GEOTIFFS]]
|[[Api session event editor measure import geotiffs|IMPORT_GEOTIFFS]]
|Import [[Measure]] [[GeoTIFF]] Collection
|Import [[Measure]] [[GeoTIFF]] Collection
|-
|-
|[[api session event editor measure import grids|IMPORT_GRIDS]]
|[[Api session event editor measure import grids|IMPORT_GRIDS]]
|Import [[Measure]] Grid Collection
|Import [[Measure]] Grid Collection
|-
|-
|[[api session event editor measure import levees|IMPORT_LEVEES]]
|[[Api session event editor measure import levees|IMPORT_LEVEES]]
|Import [[Measure]] [[Levee]] Collection
|Import [[Measure]] [[Levee]] Collection
|-
|-
|[[api session event editor measure import terrains|IMPORT_TERRAINS]]
|[[Api session event editor measure import terrains|IMPORT_TERRAINS]]
|Import [[Measure]] [[Terrain]] Collection
|Import [[Measure]] [[Terrain]] Collection
|-
|-
|[[api session event editor measure import upgrades|IMPORT_UPGRADES]]
|[[Api session event editor measure import upgrades|IMPORT_UPGRADES]]
|Import [[Measure]] Upgrade Collection
|Import [[Measure]] Upgrade Collection
|-
|-
|[[api session event editor measure remove event|REMOVE_EVENT]]
|[[Api session event editor measure remove event|REMOVE_EVENT]]
|Add a specific event of a [[Measure]] for a specific [[Action]] Type.
|Add a specific event of a [[Measure]] for a specific [[Action]] Type.
|-
|-
|[[api session event editor measure remove geotiff|REMOVE_GEOTIFF]]
|[[Api session event editor measure remove geotiff|REMOVE_GEOTIFF]]
|Remove specified [[GeoTIFF]] Spatial from a [[Measure]].
|Remove specified [[GeoTIFF]] Spatial from a [[Measure]].
|-
|-
|[[api session event editor measure remove geotiff polygons|REMOVE_GEOTIFF_POLYGONS]]
|[[Api session event editor measure remove geotiff polygons|REMOVE_GEOTIFF_POLYGONS]]
|Remove polygons from existing polygons of a [[GeoTIFF]]s Spatial of a [[Measure]].
|Remove polygons from existing polygons of a [[GeoTIFF]]s Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove geotiff terrain type|REMOVE_GEOTIFF_TERRAIN_TYPE]]
|[[Api session event editor measure remove geotiff terrain type|REMOVE_GEOTIFF_TERRAIN_TYPE]]
|Remove the [[Terrain Type]] of a [[GeoTIFF]] Spatial of a [[Measure]].
|Remove the [[Terrain Type]] of a [[GeoTIFF]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove grid|REMOVE_GRID]]
|[[Api session event editor measure remove grid|REMOVE_GRID]]
|Remove specified Grid Spatial from a [[Measure]].
|Remove specified Grid Spatial from a [[Measure]].
|-
|-
|[[api session event editor measure remove grid polygons|REMOVE_GRID_POLYGONS]]
|[[Api session event editor measure remove grid polygons|REMOVE_GRID_POLYGONS]]
|Remove polygons from existing polygons of a Grid Spatial of a [[Measure]].
|Remove polygons from existing polygons of a Grid Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove grid terrain type|REMOVE_GRID_TERRAIN_TYPE]]
|[[Api session event editor measure remove grid terrain type|REMOVE_GRID_TERRAIN_TYPE]]
|Remove the [[Terrain Type]] of a Grid Spatial of a [[Measure]].
|Remove the [[Terrain Type]] of a Grid Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove levee|REMOVE_LEVEE]]
|[[Api session event editor measure remove levee|REMOVE_LEVEE]]
|Remove specified [[Levee]] Spatials from a [[Measure]].
|Remove specified [[Levee]] Spatials from a [[Measure]].
|-
|-
|[[api session event editor measure remove levee polygons|REMOVE_LEVEE_POLYGONS]]
|[[Api session event editor measure remove levee polygons|REMOVE_LEVEE_POLYGONS]]
|Remove polygons from existing polygons of a [[Levee]] Spatial of a [[Measure]].
|Remove polygons from existing polygons of a [[Levee]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove terrain|REMOVE_TERRAIN]]
|[[Api session event editor measure remove terrain|REMOVE_TERRAIN]]
|Remove specified [[Terrain]] Spatials from a [[Measure]].
|Remove specified [[Terrain]] Spatials from a [[Measure]].
|-
|-
|[[api session event editor measure remove terrain polygons|REMOVE_TERRAIN_POLYGONS]]
|[[Api session event editor measure remove terrain polygons|REMOVE_TERRAIN_POLYGONS]]
|Remove polygons from existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]].
|Remove polygons from existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure remove upgrade|REMOVE_UPGRADE]]
|[[Api session event editor measure remove upgrade|REMOVE_UPGRADE]]
|Remove specified Upgrade Spatials from a [[Measure]].
|Remove specified Upgrade Spatials from a [[Measure]].
|-
|-
|[[api session event editor measure remove upgrade polygons|REMOVE_UPGRADE_POLYGONS]]
|[[Api session event editor measure remove upgrade polygons|REMOVE_UPGRADE_POLYGONS]]
|Remove polygons from existing polygons of a Upgrade Spatial of a [[Measure]].
|Remove polygons from existing polygons of a Upgrade Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set cost|SET_COST]]
|[[Api session event editor measure set cost|SET_COST]]
|Set the [[Cost]] of a [[Measure]] of a particular [[Cost]] type (construction, demolition) and wether it is fixed or [[Cost]] per cubic meter.
|Set the [[Cost]] of a [[Measure]] of a particular [[Cost]] type (construction, demolition) and wether it is fixed or [[Cost]] per cubic meter.
|-
|-
|[[api session event editor measure set description|SET_DESCRIPTION]]
|[[Api session event editor measure set description|SET_DESCRIPTION]]
|Set the description of a [[Measure]].
|Set the description of a [[Measure]].
|-
|-
|[[api session event editor measure set event|SET_EVENT]]
|[[Api session event editor measure set event|SET_EVENT]]
|Change an existing event of a specific [[Action]] Type of a [[Measure]].
|Change an existing event of a specific [[Action]] Type of a [[Measure]].
|-
|-
|[[api session event editor measure set geotiff|SET_GEOTIFF]]
|[[Api session event editor measure set geotiff|SET_GEOTIFF]]
|Change the [[GeoTIFF]]s applied by a specified [[Measure]].
|Change the [[GeoTIFF]]s applied by a specified [[Measure]].
|-
|-
|[[api session event editor measure set geotiff automatic polygons|SET_GEOTIFF_AUTOMATIC_POLYGONS]]
|[[Api session event editor measure set geotiff automatic polygons|SET_GEOTIFF_AUTOMATIC_POLYGONS]]
|Let the polygons be calculated automatically based on the [[GeoTIFF]]s specified in the [[GeoTIFF]] spatial of a [[Measure]].
|Let the polygons be calculated automatically based on the [[GeoTIFF]]s specified in the [[GeoTIFF]] spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set geotiff terrain type|SET_GEOTIFF_TERRAIN_TYPE]]
|[[Api session event editor measure set geotiff terrain type|SET_GEOTIFF_TERRAIN_TYPE]]
|Set the [[Terrain Type]] for a [[GeoTIFF]] Spatial of a [[Measure]].
|Set the [[Terrain Type]] for a [[GeoTIFF]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set grid|SET_GRID]]
|[[Api session event editor measure set grid|SET_GRID]]
|Change the Grids applied by a specified [[Measure]].
|Change the Grids applied by a specified [[Measure]].
|-
|-
|[[api session event editor measure set grid automatic polygons|SET_GRID_AUTOMATIC_POLYGONS]]
|[[Api session event editor measure set grid automatic polygons|SET_GRID_AUTOMATIC_POLYGONS]]
|Let the polygons be calculated automatically based on the [[Overlay]] specified in the Grid spatial of a [[Measure]].
|Let the polygons be calculated automatically based on the [[Overlay]] specified in the Grid spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set grid terrain type|SET_GRID_TERRAIN_TYPE]]
|[[Api session event editor measure set grid terrain type|SET_GRID_TERRAIN_TYPE]]
|Set the [[Terrain Type]] for a Grid Spatial of a [[Measure]].
|Set the [[Terrain Type]] for a Grid Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set image|SET_IMAGE]]
|[[Api session event editor measure set image|SET_IMAGE]]
|Set the image of a [[Measure]].
|Set the image of a [[Measure]].
|-
|-
|[[api session event editor measure set levee angle|SET_LEVEE_ANGLE]]
|[[Api session event editor measure set levee angle|SET_LEVEE_ANGLE]]
|Set the angle of [[Levee]] Spatial of a [[Measure]].
|Set the angle of [[Levee]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set levee height|SET_LEVEE_HEIGHT]]
|[[Api session event editor measure set levee height|SET_LEVEE_HEIGHT]]
|Set the inner height of [[Levee]] Spatial of a [[Measure]].
|Set the inner height of [[Levee]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set levee height relative|SET_LEVEE_HEIGHT_RELATIVE]]
|[[Api session event editor measure set levee height relative|SET_LEVEE_HEIGHT_RELATIVE]]
|Set whether the inner height of [[Levee]] Spatial of a [[Measure]] is considered relative.
|Set whether the inner height of [[Levee]] Spatial of a [[Measure]] is considered relative.
|-
|-
|[[api session event editor measure set levee type|SET_LEVEE_TYPE]]
|[[Api session event editor measure set levee type|SET_LEVEE_TYPE]]
|Set the [[Levee]] for a specified [[Levee]] Spatial of a [[Measure]].
|Set the [[Levee]] for a specified [[Levee]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set owner|SET_OWNER]]
|[[Api session event editor measure set owner|SET_OWNER]]
|Set the owner of a [[Measure]].
|Set the owner of a [[Measure]].
|-
|-
|[[api session event editor measure set requires confirmation|SET_REQUIRES_CONFIRMATION]]
|[[Api session event editor measure set requires confirmation|SET_REQUIRES_CONFIRMATION]]
|Set whether the [[Measure]] should be confirmed by other [[Stakeholder]].
|Set whether the [[Measure]] should be confirmed by other [[Stakeholder]].
|-
|-
|[[api session event editor measure set terrain edit type|SET_TERRAIN_EDIT_TYPE]]
|[[Api session event editor measure set terrain edit type|SET_TERRAIN_EDIT_TYPE]]
|Set the Edit Type of a [[Terrain]] Spatial of a [[Measure]]. This changes the way the [[Terrain]] height is adjusted: lowered, flattened or raised.
|Set the Edit Type of a [[Terrain]] Spatial of a [[Measure]]. This changes the way the [[Terrain]] height is adjusted: lowered, flattened or raised.
|-
|-
|[[api session event editor measure set terrain height|SET_TERRAIN_HEIGHT]]
|[[Api session event editor measure set terrain height|SET_TERRAIN_HEIGHT]]
|Set the inner height of [[Terrain]] Spatial of a [[Measure]].
|Set the inner height of [[Terrain]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set terrain height relative|SET_TERRAIN_HEIGHT_RELATIVE]]
|[[Api session event editor measure set terrain height relative|SET_TERRAIN_HEIGHT_RELATIVE]]
|Set whether the inner height of [[Terrain]] Spatial of a [[Measure]] is considered relative.
|Set whether the inner height of [[Terrain]] Spatial of a [[Measure]] is considered relative.
|-
|-
|[[api session event editor measure set terrain type|SET_TERRAIN_TYPE]]
|[[Api session event editor measure set terrain type|SET_TERRAIN_TYPE]]
|Set the [[Terrain Type]] for a [[Terrain]] Spatial of a [[Measure]].
|Set the [[Terrain Type]] for a [[Terrain]] Spatial of a [[Measure]].
|-
|-
|[[api session event editor measure set upgrade type|SET_UPGRADE_TYPE]]
|[[Api session event editor measure set upgrade type|SET_UPGRADE_TYPE]]
|Set the [[Upgrade Type]] for an Upgrade Spatial of a [[Measure]].
|Set the [[Upgrade Type]] for an Upgrade Spatial of a [[Measure]].
|}
|}
Line 189: Line 189:
!Description
!Description
|-
|-
|[[api session event editor measure import building measure|IMPORT_BUILDING_MEASURE]]
|[[Api session event editor measure import building measure|IMPORT_BUILDING_MEASURE]]
|Use IMPORT_BUILDINGS instead, same event with option to set existing [[Measure]].
|Use IMPORT_BUILDINGS instead, same event with option to set existing [[Measure]].
|}
|}
{{article end|seealso=*[[Api Events]]}}
{{article end|seealso=*[[Api Events]]
*[[Api session items measures]]
}}


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

Latest revision as of 12:08, 1 April 2026

Api session event editor measure Events.

Measure editing.

Name Description
ADD Add Measure for Stakeholder
DUPLICATE Duplicate specified Measure.
REMOVE Remove specified Measure.
SET_NAME Set the name of a Measure.

Specific Events:

Name Description
ADD_BUILDING Add a new Building to specified Measure
ADD_EVENT Add a new event to a Measure for a specific Action Type.
ADD_GEOTIFF Add a new GeoTIFF Spatial to a Measure.
ADD_GEOTIFF_POLYGONS Add polygons to existing polygons of a GeoTIFF Spatial of a Measure.
ADD_GRID Add a new Grid Spatial to a Measure.
ADD_GRID_POLYGONS Add polygons to existing polygons of a Grid Spatial of a Measure.
ADD_LEVEE Add a new Levee Spatial of a specified Levee to a Measure.
ADD_LEVEE_POLYGONS Add polygons to existing outer (or inner) polygons of a Levee Spatial of a Measure.
ADD_TERRAIN Add a new Terrain Spatial to a Measure.
ADD_TERRAIN_POLYGONS Add polygons to existing outer (or inner) polygons of a Terrain Spatial of a Measure.
ADD_UPGRADE Add a new Upgrade Spatial to a Measure.
ADD_UPGRADE_POLYGONS Add polygons to existing polygons of an Upgrade Spatial of a Measure.
DUPLICATE_BUILDING Duplicate specified Measure Building.
IMPORT_BUILDINGS Import Measure Building Collection
IMPORT_GEOTIFFS Import Measure GeoTIFF Collection
IMPORT_GRIDS Import Measure Grid Collection
IMPORT_LEVEES Import Measure Levee Collection
IMPORT_TERRAINS Import Measure Terrain Collection
IMPORT_UPGRADES Import Measure Upgrade Collection
REMOVE_EVENT Add a specific event of a Measure for a specific Action Type.
REMOVE_GEOTIFF Remove specified GeoTIFF Spatial from a Measure.
REMOVE_GEOTIFF_POLYGONS Remove polygons from existing polygons of a GeoTIFFs Spatial of a Measure.
REMOVE_GEOTIFF_TERRAIN_TYPE Remove the Terrain Type of a GeoTIFF Spatial of a Measure.
REMOVE_GRID Remove specified Grid Spatial from a Measure.
REMOVE_GRID_POLYGONS Remove polygons from existing polygons of a Grid Spatial of a Measure.
REMOVE_GRID_TERRAIN_TYPE Remove the Terrain Type of a Grid Spatial of a Measure.
REMOVE_LEVEE Remove specified Levee Spatials from a Measure.
REMOVE_LEVEE_POLYGONS Remove polygons from existing polygons of a Levee Spatial of a Measure.
REMOVE_TERRAIN Remove specified Terrain Spatials from a Measure.
REMOVE_TERRAIN_POLYGONS Remove polygons from existing outer (or inner) polygons of a Terrain Spatial of a Measure.
REMOVE_UPGRADE Remove specified Upgrade Spatials from a Measure.
REMOVE_UPGRADE_POLYGONS Remove polygons from existing polygons of a Upgrade Spatial of a Measure.
SET_COST Set the Cost of a Measure of a particular Cost type (construction, demolition) and wether it is fixed or Cost per cubic meter.
SET_DESCRIPTION Set the description of a Measure.
SET_EVENT Change an existing event of a specific Action Type of a Measure.
SET_GEOTIFF Change the GeoTIFFs applied by a specified Measure.
SET_GEOTIFF_AUTOMATIC_POLYGONS Let the polygons be calculated automatically based on the GeoTIFFs specified in the GeoTIFF spatial of a Measure.
SET_GEOTIFF_TERRAIN_TYPE Set the Terrain Type for a GeoTIFF Spatial of a Measure.
SET_GRID Change the Grids applied by a specified Measure.
SET_GRID_AUTOMATIC_POLYGONS Let the polygons be calculated automatically based on the Overlay specified in the Grid spatial of a Measure.
SET_GRID_TERRAIN_TYPE Set the Terrain Type for a Grid Spatial of a Measure.
SET_IMAGE Set the image of a Measure.
SET_LEVEE_ANGLE Set the angle of Levee Spatial of a Measure.
SET_LEVEE_HEIGHT Set the inner height of Levee Spatial of a Measure.
SET_LEVEE_HEIGHT_RELATIVE Set whether the inner height of Levee Spatial of a Measure is considered relative.
SET_LEVEE_TYPE Set the Levee for a specified Levee Spatial of a Measure.
SET_OWNER Set the owner of a Measure.
SET_REQUIRES_CONFIRMATION Set whether the Measure should be confirmed by other Stakeholder.
SET_TERRAIN_EDIT_TYPE Set the Edit Type of a Terrain Spatial of a Measure. This changes the way the Terrain height is adjusted: lowered, flattened or raised.
SET_TERRAIN_HEIGHT Set the inner height of Terrain Spatial of a Measure.
SET_TERRAIN_HEIGHT_RELATIVE Set whether the inner height of Terrain Spatial of a Measure is considered relative.
SET_TERRAIN_TYPE Set the Terrain Type for a Terrain Spatial of a Measure.
SET_UPGRADE_TYPE Set the Upgrade Type for an Upgrade Spatial of a Measure.

Deprecated Events:

Name Description
IMPORT_BUILDING_MEASURE Use IMPORT_BUILDINGS instead, same event with option to set existing Measure.