Api session event editor overlay

Api session event editor overlay Events.

Overlay editing.

Name	Description
ADD	Add a new Overlay of the specified type.
APPEND_ATTRIBUTE	Appended to existing Overlay attribute value
DUPLICATE	Duplicate existing Overlay
REMOVE	Remove the specified Overlay.
REMOVE_ATTRIBUTE	Remove the specified attributes of the specified Overlay. The attributes, including attributes which are added to an Overlay by default, are removed entirely.
SET_ATTRIBUTE	Set Overlay attribute value
SET_ATTRIBUTES	Set multiple Overlay attribute values
SET_NAME	Set the name for a specified Overlay.

Specific Events:

Name	Description
ADD_LEGEND_ENTRY	Add a Legend Entry to a specified Overlay. The Overlay must have a custom legend before entries can be added to it.
ADD_OVERLAY_FUNCTION	Add a Function to highlight to a specified FUNCTION Overlay.
ADD_RESULT_CHILD	Add a specified result type as a child Overlay to a specified grid Overlay. The child Overlay's result will be based on the parent's calculation, allowing you to get multiple types of results from the same calculation.
ADD_TYPE	Add multiple new Overlay of the specified types.
REMOVE_LEGEND_ENTRY	Remove the specified legend entries from a specified Overlay. The Overlay must have a custom legend before entries can be removed from it.
REMOVE_OVERLAY_FUNCTION	Remove a specified Function to highlight from a specified FUNCTION_HIGHLIGHT Overlay.
REMOVE_PREQUEL	Remove a Grid Overlay's prequel Overlay.
REMOVE_WATER_WEATHER	Remove Water Weather
SAVE_GRID	Create a copy of each specified Overlay. The copies will have the same Setting and attributes, but can be edited independently of the originals.
SET_ATTRIBUTE_OVERLAY_COLOR_ATTRIBUTE	Set which attribute a specified ATTRIBUTE Overlay should use to color the items it finds. If present in the item, it will use that attribute's color to color the item in the 3D world. If absent, the Overlay's color will be used.
SET_ATTRIBUTE_OVERLAY_VALUES	Set which type of item and which attribute a specified ATTRIBUTE Overlay should highlight. The ATTRIBUTE Overlay will highlight each item it finds which is both of the specified maptype as well as has the specified attribute
SET_AVG_DISTANCE	Set the averaging distance for a specified AVG Overlay.
SET_COMBO_FORMULA	Set formula for a Combo Overlay.
SET_CUSTOM_LEGEND	Set whether the specified Overlay has a custom legend. If the specified Overlay is reverted to use a default Overlay, any custom legend information for the Overlay is removed.
SET_DISCHARGE_METHOD	Set Discharge Method
SET_GEOTIFF	Change the GeoTIFF displayed by a specified GeoTIFF Overlay.
SET_GRID_ACTIVE	Activates or deactivates an Overlay. Only active Overlay are recalculated by the simulation.
SET_HEAT_MODEL	Set Heat Model
SET_IMAGE	Change the icon displayed in the navigation window by the Overlay. Only existing Overlay Project Asset are allowed.
SET_KEY_VALUE	Change a key for a specified Overlay. The Overlay must be an Overlay which makes use of keys to read attributes of geographical items, as input for its calculation.
SET_LEGEND_ENTRY_COLOR	Change the color of a specified legend entry of a custom legend of a specified Overlay.
SET_LEGEND_ENTRY_NAME	Change the name of a specified legend entry of a custom legend of a specified Overlay.
SET_LEGEND_ENTRY_VALUE	Change the value of a specified legend entry of a custom legend of a specified Overlay.
SET_NET_OVERLAY	Set the visualization style for a specified network Overlay.
SET_NEURAL_NETWORK	Set the Neural Network for an Inference Overlay.
SET_OVERLAY_AREA	Add or remove specified Area to or from a specified AREAS Overlay. Unincluded Area which are already related to the Overlay will remain related. Unincluded Area which are not related to the Overlay will remain unrelated.
SET_OVERLAY_IMAGE	Change the image displayed by a specified IMAGE Overlay. The image must be uploaded in the "Overlay" directory.
SET_OVERLAY_PRIMARY_COLOR	Set the color a specified FUNCTION or ATTRIBUTE Overlay uses to highlight found data.
SET_OVERLAY_REMAINDER_COLOR	Set the color a specified FUNCTION or ATTRIBUTE Overlay uses to color parts of the map where no relevant data is found.
SET_OVERLAY_SOURCE	Add or remove specified Source to or from a specified SOURCE Overlay. Unincluded Source which are already related to the Overlay will remain related. Unincluded Source which are not related to the Overlay will remain unrelated.
SET_PARENT	Set a parent Overlay for a specified Overlay. This will cause the specified Overlay to be a subselectable Overlay of the parent. It is not possible to set an Overlay which has a parent itself as a parent of another Overlay.
SET_PREQUEL	Set prequel Overlay.
SET_RASTERIZATION	Set the type of rasterization a specified AVG or Distance Overlay should do.
SET_RESULT_TYPE	Set the result type of a specified grid Overlay. The same calculation will be performed, but a different aspect of the calculation will be tracked and output.
SET_SERVICE_CRS	Set the prefered CRS for the Service Source of a specified Service Overlay.
SET_SERVICE_FORCE_XY	Set the prefered option to force the CRS order to longitude/latitude for the Service Source of a specified Service Overlay.
SET_SERVICE_LAYER	Set the Service layer names for a specified Service Overlay and Timeframe.
SET_SERVICE_SOURCE	Set the Service Source for a specified Service Overlay.
SET_SHOW_DIFFERENCE	Set whether a specified grid Overlay has a difference option. If an Overlay has a difference option, an addition output is available computed from the difference between the CURRENT and MAQUETTE outputs.
SET_SHOW_SYSTEM_VISUALIZATION	Set whether a specified Overlay visualizes the graph of systems which dictates its calculation. Pipes, center points of Area, etc.
SET_TENSOR_NORMALIZED	Set whether an input tensor of an Inference Overlay should be normalized when provided to a Neural Network.
SET_TENSOR_PREQUEL	Set the Inference Prequel for an input tensor of an Inference Overlay.
SET_TENSOR_RESULT_TYPE	Set the Inference Result for an output tensor of an Inference Overlay.
SET_TENSOR_VALUE_TYPE	Set the Value Type for an input tensor of an Inference Overlay.
SET_VISIBLE	Visualizes or hides an Overlay in the navigation Panel.
SET_WATER_MODE	Set Water Mode
SET_WATER_WEATHER	Set a specified Weather to serve as input for a specified water Overlay.
SWAP_ORDER	Swap Order

Deprecated Events:

Name	Description
REFRESH_GRID	Deprecated Functionality, entire map is always updated when UPDATE is called. Note that when the "Auto calculation" is not active, an editor/update/ event is required to generate the new Overlay results. Or for long-running updates use: editor/set_scheduled_update/ to schedule an update.

See also

• Api Events
• Api session items overlays