Api session event editor overlay - Revision history

Frank@tygron.nl at 12:10, 1 April 2026

2026-04-01T12:10:10Z

Frank@tygron.nl at 11:43, 1 April 2026

2026-04-01T11:43:31Z

← Older revision		Revision as of 11:43, 1 April 2026
Line 189:		Line 189:
	\|Deprecated [[Function]]ality, 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.		\|Deprecated [[Function]]ality, 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.
	\|}		\|}
	{{article end\|seealso=*[[Api Events]]}}		{{article end\|seealso=*[[Api Events]]
			*[[api session items overlays]]
			}}

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

Frank@tygron.nl at 09:19, 1 April 2026

2026-04-01T09:19:06Z

← Older revision		Revision as of 09:19, 1 April 2026
Line 1:		Line 1:
	~~API api~~ session event editor overlay Events.		Api session event editor overlay Events.

	[[Overlay]] editing.		[[Overlay]] editing.

Frank@tygron.nl at 08:15, 31 March 2026

2026-03-31T08:15:17Z

← Older revision		Revision as of 08:15, 31 March 2026
Line 82:		Line 82:
	\|-		\|-
	\|[[api session event editor overlay set geotiff\|SET_GEOTIFF]]		\|[[api session event editor overlay set geotiff\|SET_GEOTIFF]]
	\|Change the GeoTIFF displayed by a specified GeoTIFF [[Overlay]].		\|Change the [[GeoTIFF]] displayed by a specified [[GeoTIFF]] [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay set grid active\|SET_GRID_ACTIVE]]		\|[[api session event editor overlay set grid active\|SET_GRID_ACTIVE]]

Frank@tygron.nl at 08:08, 31 March 2026

2026-03-31T08:08:31Z

← Older revision		Revision as of 08:08, 31 March 2026
Line 1:		Line 1:
	API api session event editor overlay Events.		API api session event editor overlay Events.

	Overlay editing.		[[Overlay]] editing.
	{\|class=wikitable		{\|class=wikitable
	!Name		!Name

Frank@tygron.nl at 07:53, 31 March 2026

2026-03-31T07:53:57Z

Frank@tygron.nl at 14:16, 30 March 2026

2026-03-30T14:16:00Z

Frank@tygron.nl at 12:23, 30 March 2026

2026-03-30T12:23:23Z

← Older revision		Revision as of 12:23, 30 March 2026
Line 85:		Line 85:
	\|-		\|-
	\|[[api session event editor overlay set grid active\|SET_GRID_ACTIVE]]		\|[[api session event editor overlay set grid active\|SET_GRID_ACTIVE]]
	\|Activates or deactivates an [[Overlay]]. Only active ~~Overlays~~ are recalculated by the simulation.		\|Activates or deactivates an [[Overlay]]. Only active [[Overlay]] are recalculated by the simulation.
	\|-		\|-
	\|[[api session event editor overlay set heat model\|SET_HEAT_MODEL]]		\|[[api session event editor overlay set heat model\|SET_HEAT_MODEL]]
Line 115:		Line 115:
	\|-		\|-
	\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]		\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]
	\|Change the image displayed by a specified IMAGE [[Overlay]]. The image must be uploaded in the "~~Overlays~~" directory.		\|Change the image displayed by a specified IMAGE [[Overlay]]. The image must be uploaded in the "[[Overlay]]" directory.
	\|-		\|-
	\|[[api session event editor overlay set overlay primary color\|SET_OVERLAY_PRIMARY_COLOR]]		\|[[api session event editor overlay set overlay primary color\|SET_OVERLAY_PRIMARY_COLOR]]

Frank@tygron.nl: Created page with "API api session event editor overlay Events. Overlay editing. {|class=wikitable !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..."

2026-03-30T10:19:13Z

Created page with "API api session event editor overlay Events. Overlay editing. {|class=wikitable !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..."

New page

API api session event editor overlay Events.

Overlay editing.
{|class=wikitable
!Name
!Description
|-
|[[api session event editor overlay add|ADD]]
|Add a new [[Overlay]] of the specified type.
|-
|[[api session event editor overlay append attribute|APPEND_ATTRIBUTE]]
|Appended to existing [[Overlay]] attribute value
|-
|[[api session event editor overlay duplicate|DUPLICATE]]
|Duplicate existing [[Overlay]]
|-
|[[api session event editor overlay remove|REMOVE]]
|Remove the specified [[Overlay]]s.
|-
|[[api session event editor overlay remove attribute|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.
|-
|[[api session event editor overlay set attribute|SET_ATTRIBUTE]]
|Set [[Overlay]] attribute value
|-
|[[api session event editor overlay set attributes|SET_ATTRIBUTES]]
|Set multiple [[Overlay]] attribute values
|-
|[[api session event editor overlay set name|SET_NAME]]
|Set the name for a specified [[Overlay]].
|}

Specific Events:
{|class=wikitable
!Name
!Description
|-
|[[api session event editor overlay add legend entry|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.
|-
|[[api session event editor overlay add overlay function|ADD_OVERLAY_FUNCTION]]
|Add a function to highlight to a specified FUNCTION [[Overlay]].
|-
|[[api session event editor overlay add result child|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.
|-
|[[api session event editor overlay add type|ADD_TYPE]]
|Add multiple new [[Overlay]]s of the specified types.
|-
|[[api session event editor overlay remove legend entry|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.
|-
|[[api session event editor overlay remove overlay function|REMOVE_OVERLAY_FUNCTION]]
|Remove a specified function to highlight from a specified FUNCTION_HIGHLIGHT [[Overlay]].
|-
|[[api session event editor overlay remove prequel|REMOVE_PREQUEL]]
|Remove a Grid [[Overlay]]'s prequel Overlay.
|-
|[[api session event editor overlay remove water weather|REMOVE_WATER_WEATHER]]
|Remove Water [[Weather]]
|-
|[[api session event editor overlay save grid|SAVE_GRID]]
|Create a copy of each specified [[Overlay]]. The copies will have the same settings and attributes, but can be edited independently of the originals.
|-
|[[api session event editor overlay set attribute overlay color attribute|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.
|-
|[[api session event editor overlay set attribute overlay values|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
|-
|[[api session event editor overlay set avg distance|SET_AVG_DISTANCE]]
|Set the averaging distance for a specified AVG [[Overlay]].
|-
|[[api session event editor overlay set combo formula|SET_COMBO_FORMULA]]
|Set formula for a Combo [[Overlay]].
|-
|[[api session event editor overlay set custom legend|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.
|-
|[[api session event editor overlay set discharge method|SET_DISCHARGE_METHOD]]
|Set Discharge Method
|-
|[[api session event editor overlay set geotiff|SET_GEOTIFF]]
|Change the GeoTIFF displayed by a specified GeoTIFF [[Overlay]].
|-
|[[api session event editor overlay set grid active|SET_GRID_ACTIVE]]
|Activates or deactivates an [[Overlay]]. Only active Overlays are recalculated by the simulation.
|-
|[[api session event editor overlay set heat model|SET_HEAT_MODEL]]
|Set Heat Model
|-
|[[api session event editor overlay set image|SET_IMAGE]]
|Change the icon displayed in the navigation window by the [[Overlay]]. Only existing overlay project assets are allowed.
|-
|[[api session event editor overlay set key value|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.
|-
|[[api session event editor overlay set legend entry color|SET_LEGEND_ENTRY_COLOR]]
|Change the color of a specified legend entry of a custom legend of a specified [[Overlay]].
|-
|[[api session event editor overlay set legend entry name|SET_LEGEND_ENTRY_NAME]]
|Change the name of a specified legend entry of a custom legend of a specified [[Overlay]].
|-
|[[api session event editor overlay set legend entry value|SET_LEGEND_ENTRY_VALUE]]
|Change the value of a specified legend entry of a custom legend of a specified [[Overlay]].
|-
|[[api session event editor overlay set net overlay|SET_NET_OVERLAY]]
|Set the visualization style for a specified network [[Overlay]].
|-
|[[api session event editor overlay set neural network|SET_NEURAL_NETWORK]]
|Set the [[Neural Network]] for an Inference [[Overlay]].
|-
|[[api session event editor overlay set overlay area|SET_OVERLAY_AREA]]
|Add or remove specified areas to or from a specified AREAS [[Overlay]]. Unincluded areas which are already related to the Overlay will remain related. Unincluded areas which are not related to the Overlay will remain unrelated.
|-
|[[api session event editor overlay set overlay image|SET_OVERLAY_IMAGE]]
|Change the image displayed by a specified IMAGE [[Overlay]]. The image must be uploaded in the "Overlays" directory.
|-
|[[api session event editor overlay set overlay primary color|SET_OVERLAY_PRIMARY_COLOR]]
|Set the color a specified FUNCTION or ATTRIBUTE [[Overlay]] uses to highlight found data.
|-
|[[api session event editor overlay set overlay remainder color|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.
|-
|[[api session event editor overlay set overlay source|SET_OVERLAY_SOURCE]]
|Add or remove specified sources to or from a specified SOURCE [[Overlay]]. Unincluded sources which are already related to the Overlay will remain related. Unincluded sources which are not related to the Overlay will remain unrelated.
|-
|[[api session event editor overlay set parent|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.
|-
|[[api session event editor overlay set prequel|SET_PREQUEL]]
|Set prequel [[Overlay]].
|-
|[[api session event editor overlay set rasterization|SET_RASTERIZATION]]
|Set the type of rasterization a specified AVG or Distance [[Overlay]] should do.
|-
|[[api session event editor overlay set result type|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.
|-
|[[api session event editor overlay set service crs|SET_SERVICE_CRS]]
|Set the prefered CRS for the Service source of a specified Service [[Overlay]].
|-
|[[api session event editor overlay set service force xy|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]].
|-
|[[api session event editor overlay set service layer|SET_SERVICE_LAYER]]
|Set the Service layer names for a specified Service [[Overlay]] and timeframe.
|-
|[[api session event editor overlay set service source|SET_SERVICE_SOURCE]]
|Set the Service source for a specified Service [[Overlay]].
|-
|[[api session event editor overlay set show difference|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.
|-
|[[api session event editor overlay set show system visualization|SET_SHOW_SYSTEM_VISUALIZATION]]
|Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center points of areas, etc.
|-
|[[api session event editor overlay set tensor normalized|SET_TENSOR_NORMALIZED]]
|Set whether an input tensor of an Inference [[Overlay]] should be normalized when provided to a neural network.
|-
|[[api session event editor overlay set tensor prequel|SET_TENSOR_PREQUEL]]
|Set the Inference Prequel for an input tensor of an Inference [[Overlay]].
|-
|[[api session event editor overlay set tensor result type|SET_TENSOR_RESULT_TYPE]]
|Set the Inference Result for an output tensor of an Inference [[Overlay]].
|-
|[[api session event editor overlay set tensor value type|SET_TENSOR_VALUE_TYPE]]
|Set the Value Type for an input tensor of an Inference [[Overlay]].
|-
|[[api session event editor overlay set visible|SET_VISIBLE]]
|Visualizes or hides an [[Overlay]] in the navigation panel.
|-
|[[api session event editor overlay set water mode|SET_WATER_MODE]]
|Set Water Mode
|-
|[[api session event editor overlay set water weather|SET_WATER_WEATHER]]
|Set a specified weather to serve as input for a specified water [[Overlay]].
|-
|[[api session event editor overlay swap order|SWAP_ORDER]]
|Swap Order
|}

Deprecated Events:
{|class=wikitable
!Name
!Description
|-
|[[api session event editor overlay refresh grid|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.
|}
{{article end|seealso=*[[Api Events]]}}

[[Category:API]]

← Older revision		Revision as of 07:53, 31 March 2026
Line 16:		Line 16:
	\|-		\|-
	\|[[api session event editor overlay remove\|REMOVE]]		\|[[api session event editor overlay remove\|REMOVE]]
	\|Remove the specified [[Overlay]]s.		\|Remove the specified [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay remove attribute\|REMOVE_ATTRIBUTE]]		\|[[api session event editor overlay remove attribute\|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.		\|Remove the specified attributes of the specified [[Overlay]]. The attributes, including attributes which are added to an [[Overlay]] by default, are removed entirely.
	\|-		\|-
	\|[[api session event editor overlay set attribute\|SET_ATTRIBUTE]]		\|[[api session event editor overlay set attribute\|SET_ATTRIBUTE]]
Line 37:		Line 37:
	\|-		\|-
	\|[[api session event editor overlay add legend entry\|ADD_LEGEND_ENTRY]]		\|[[api session event editor overlay add legend entry\|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 a Legend Entry to a specified [[Overlay]]. The [[Overlay]] must have a custom legend before entries can be added to it.
	\|-		\|-
	\|[[api session event editor overlay add overlay function\|ADD_OVERLAY_FUNCTION]]		\|[[api session event editor overlay add overlay function\|ADD_OVERLAY_FUNCTION]]
Line 43:		Line 43:
	\|-		\|-
	\|[[api session event editor overlay add result child\|ADD_RESULT_CHILD]]		\|[[api session event editor overlay add result child\|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 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.
	\|-		\|-
	\|[[api session event editor overlay add type\|ADD_TYPE]]		\|[[api session event editor overlay add type\|ADD_TYPE]]
	\|Add multiple new [[Overlay]]s of the specified types.		\|Add multiple new [[Overlay]] of the specified types.
	\|-		\|-
	\|[[api session event editor overlay remove legend entry\|REMOVE_LEGEND_ENTRY]]		\|[[api session event editor overlay remove legend entry\|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 the specified legend entries from a specified [[Overlay]]. The [[Overlay]] must have a custom legend before entries can be removed from it.
	\|-		\|-
	\|[[api session event editor overlay remove overlay function\|REMOVE_OVERLAY_FUNCTION]]		\|[[api session event editor overlay remove overlay function\|REMOVE_OVERLAY_FUNCTION]]
Line 55:		Line 55:
	\|-		\|-
	\|[[api session event editor overlay remove prequel\|REMOVE_PREQUEL]]		\|[[api session event editor overlay remove prequel\|REMOVE_PREQUEL]]
	\|Remove a Grid [[Overlay]]'s prequel Overlay.		\|Remove a Grid [[Overlay]]'s prequel [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay remove water weather\|REMOVE_WATER_WEATHER]]		\|[[api session event editor overlay remove water weather\|REMOVE_WATER_WEATHER]]
Line 61:		Line 61:
	\|-		\|-
	\|[[api session event editor overlay save grid\|SAVE_GRID]]		\|[[api session event editor overlay save grid\|SAVE_GRID]]
	\|Create a copy of each specified [[Overlay]]. The copies will have the same [[Setting]]s and attributes, but can be edited independently of the originals.		\|Create a copy of each specified [[Overlay]]. The copies will have the same [[Setting]] and attributes, but can be edited independently of the originals.
	\|-		\|-
	\|[[api session event editor overlay set attribute overlay color attribute\|SET_ATTRIBUTE_OVERLAY_COLOR_ATTRIBUTE]]		\|[[api session event editor overlay set attribute overlay color attribute\|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 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.
	\|-		\|-
	\|[[api session event editor overlay set attribute overlay values\|SET_ATTRIBUTE_OVERLAY_VALUES]]		\|[[api session event editor overlay set attribute overlay values\|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 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
	\|-		\|-
	\|[[api session event editor overlay set avg distance\|SET_AVG_DISTANCE]]		\|[[api session event editor overlay set avg distance\|SET_AVG_DISTANCE]]
Line 76:		Line 76:
	\|-		\|-
	\|[[api session event editor overlay set custom legend\|SET_CUSTOM_LEGEND]]		\|[[api session event editor overlay set custom legend\|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 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.
	\|-		\|-
	\|[[api session event editor overlay set discharge method\|SET_DISCHARGE_METHOD]]		\|[[api session event editor overlay set discharge method\|SET_DISCHARGE_METHOD]]
Line 91:		Line 91:
	\|-		\|-
	\|[[api session event editor overlay set image\|SET_IMAGE]]		\|[[api session event editor overlay set image\|SET_IMAGE]]
	\|Change the icon displayed in the navigation window by the [[Overlay]]. Only existing [[Overlay]] [[Project Asset]]s are allowed.		\|Change the icon displayed in the navigation window by the [[Overlay]]. Only existing [[Overlay]] [[Project Asset]] are allowed.
	\|-		\|-
	\|[[api session event editor overlay set key value\|SET_KEY_VALUE]]		\|[[api session event editor overlay set key value\|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.		\|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.
	\|-		\|-
	\|[[api session event editor overlay set legend entry color\|SET_LEGEND_ENTRY_COLOR]]		\|[[api session event editor overlay set legend entry color\|SET_LEGEND_ENTRY_COLOR]]
Line 112:		Line 112:
	\|-		\|-
	\|[[api session event editor overlay set overlay area\|SET_OVERLAY_AREA]]		\|[[api session event editor overlay set overlay area\|SET_OVERLAY_AREA]]
	\|Add or remove specified [[Area]]s to or from a specified AREAS [[Overlay]]. Unincluded [[Area]] which are already related to the Overlay will remain related. Unincluded ~~areas~~ which are not related to the Overlay will remain unrelated.		\|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.
	\|-		\|-
	\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]		\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]
Line 124:		Line 124:
	\|-		\|-
	\|[[api session event editor overlay set overlay source\|SET_OVERLAY_SOURCE]]		\|[[api session event editor overlay set overlay source\|SET_OVERLAY_SOURCE]]
	\|Add or remove specified [[Source]]s to or from a specified SOURCE [[Overlay]]. Unincluded [[Source]] which are already related to the Overlay will remain related. Unincluded ~~sources~~ which are not related to the Overlay will remain unrelated.		\|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.
	\|-		\|-
	\|[[api session event editor overlay set parent\|SET_PARENT]]		\|[[api session event editor overlay set parent\|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 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]].
	\|-		\|-
	\|[[api session event editor overlay set prequel\|SET_PREQUEL]]		\|[[api session event editor overlay set prequel\|SET_PREQUEL]]
Line 151:		Line 151:
	\|-		\|-
	\|[[api session event editor overlay set show difference\|SET_SHOW_DIFFERENCE]]		\|[[api session event editor overlay set show difference\|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 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.
	\|-		\|-
	\|[[api session event editor overlay set show system visualization\|SET_SHOW_SYSTEM_VISUALIZATION]]		\|[[api session event editor overlay set show system visualization\|SET_SHOW_SYSTEM_VISUALIZATION]]
	\|Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center points of [[Area]]s, etc.		\|Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center points of [[Area]], etc.
	\|-		\|-
	\|[[api session event editor overlay set tensor normalized\|SET_TENSOR_NORMALIZED]]		\|[[api session event editor overlay set tensor normalized\|SET_TENSOR_NORMALIZED]]

← Older revision		Revision as of 14:16, 30 March 2026
Line 40:		Line 40:
	\|-		\|-
	\|[[api session event editor overlay add overlay function\|ADD_OVERLAY_FUNCTION]]		\|[[api session event editor overlay add overlay function\|ADD_OVERLAY_FUNCTION]]
	\|Add a ~~function~~ to highlight to a specified FUNCTION [[Overlay]].		\|Add a [[Function]] to highlight to a specified FUNCTION [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay add result child\|ADD_RESULT_CHILD]]		\|[[api session event editor overlay add result child\|ADD_RESULT_CHILD]]
Line 52:		Line 52:
	\|-		\|-
	\|[[api session event editor overlay remove overlay function\|REMOVE_OVERLAY_FUNCTION]]		\|[[api session event editor overlay remove overlay function\|REMOVE_OVERLAY_FUNCTION]]
	\|Remove a specified ~~function~~ to highlight from a specified FUNCTION_HIGHLIGHT [[Overlay]].		\|Remove a specified [[Function]] to highlight from a specified FUNCTION_HIGHLIGHT [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay remove prequel\|REMOVE_PREQUEL]]		\|[[api session event editor overlay remove prequel\|REMOVE_PREQUEL]]
Line 61:		Line 61:
	\|-		\|-
	\|[[api session event editor overlay save grid\|SAVE_GRID]]		\|[[api session event editor overlay save grid\|SAVE_GRID]]
	\|Create a copy of each specified [[Overlay]]. The copies will have the same ~~settings~~ and attributes, but can be edited independently of the originals.		\|Create a copy of each specified [[Overlay]]. The copies will have the same [[Setting]]s and attributes, but can be edited independently of the originals.
	\|-		\|-
	\|[[api session event editor overlay set attribute overlay color attribute\|SET_ATTRIBUTE_OVERLAY_COLOR_ATTRIBUTE]]		\|[[api session event editor overlay set attribute overlay color attribute\|SET_ATTRIBUTE_OVERLAY_COLOR_ATTRIBUTE]]
Line 91:		Line 91:
	\|-		\|-
	\|[[api session event editor overlay set image\|SET_IMAGE]]		\|[[api session event editor overlay set image\|SET_IMAGE]]
	\|Change the icon displayed in the navigation window by the [[Overlay]]. Only existing ~~overlay project assets~~ are allowed.		\|Change the icon displayed in the navigation window by the [[Overlay]]. Only existing [[Overlay]] [[Project Asset]]s are allowed.
	\|-		\|-
	\|[[api session event editor overlay set key value\|SET_KEY_VALUE]]		\|[[api session event editor overlay set key value\|SET_KEY_VALUE]]
Line 112:		Line 112:
	\|-		\|-
	\|[[api session event editor overlay set overlay area\|SET_OVERLAY_AREA]]		\|[[api session event editor overlay set overlay area\|SET_OVERLAY_AREA]]
	\|Add or remove specified ~~areas~~ to or from a specified AREAS [[Overlay]]. Unincluded ~~areas~~ which are already related to the Overlay will remain related. Unincluded areas which are not related to the Overlay will remain unrelated.		\|Add or remove specified [[Area]]s to or from a specified AREAS [[Overlay]]. Unincluded [[Area]] which are already related to the Overlay will remain related. Unincluded areas which are not related to the Overlay will remain unrelated.
	\|-		\|-
	\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]		\|[[api session event editor overlay set overlay image\|SET_OVERLAY_IMAGE]]
Line 124:		Line 124:
	\|-		\|-
	\|[[api session event editor overlay set overlay source\|SET_OVERLAY_SOURCE]]		\|[[api session event editor overlay set overlay source\|SET_OVERLAY_SOURCE]]
	\|Add or remove specified ~~sources~~ to or from a specified SOURCE [[Overlay]]. Unincluded ~~sources~~ which are already related to the Overlay will remain related. Unincluded sources which are not related to the Overlay will remain unrelated.		\|Add or remove specified [[Source]]s to or from a specified SOURCE [[Overlay]]. Unincluded [[Source]] which are already related to the Overlay will remain related. Unincluded sources which are not related to the Overlay will remain unrelated.
	\|-		\|-
	\|[[api session event editor overlay set parent\|SET_PARENT]]		\|[[api session event editor overlay set parent\|SET_PARENT]]
Line 139:		Line 139:
	\|-		\|-
	\|[[api session event editor overlay set service crs\|SET_SERVICE_CRS]]		\|[[api session event editor overlay set service crs\|SET_SERVICE_CRS]]
	\|Set the prefered CRS for the Service ~~source~~ of a specified Service [[Overlay]].		\|Set the prefered CRS for the Service [[Source]] of a specified Service [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay set service force xy\|SET_SERVICE_FORCE_XY]]		\|[[api session event editor overlay set service force xy\|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 the prefered option to force the CRS order to longitude/latitude for the Service [[Source]] of a specified Service [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay set service layer\|SET_SERVICE_LAYER]]		\|[[api session event editor overlay set service layer\|SET_SERVICE_LAYER]]
	\|Set the Service layer names for a specified Service [[Overlay]] and ~~timeframe~~.		\|Set the Service layer names for a specified Service [[Overlay]] and [[Time]]frame.
	\|-		\|-
	\|[[api session event editor overlay set service source\|SET_SERVICE_SOURCE]]		\|[[api session event editor overlay set service source\|SET_SERVICE_SOURCE]]
	\|Set the Service ~~source~~ for a specified Service [[Overlay]].		\|Set the Service [[Source]] for a specified Service [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay set show difference\|SET_SHOW_DIFFERENCE]]		\|[[api session event editor overlay set show difference\|SET_SHOW_DIFFERENCE]]
Line 154:		Line 154:
	\|-		\|-
	\|[[api session event editor overlay set show system visualization\|SET_SHOW_SYSTEM_VISUALIZATION]]		\|[[api session event editor overlay set show system visualization\|SET_SHOW_SYSTEM_VISUALIZATION]]
	\|Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center points of ~~areas~~, etc.		\|Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center points of [[Area]]s, etc.
	\|-		\|-
	\|[[api session event editor overlay set tensor normalized\|SET_TENSOR_NORMALIZED]]		\|[[api session event editor overlay set tensor normalized\|SET_TENSOR_NORMALIZED]]
	\|Set whether an input tensor of an Inference [[Overlay]] should be normalized when provided to a ~~neural network~~.		\|Set whether an input tensor of an Inference [[Overlay]] should be normalized when provided to a [[Neural Network]].
	\|-		\|-
	\|[[api session event editor overlay set tensor prequel\|SET_TENSOR_PREQUEL]]		\|[[api session event editor overlay set tensor prequel\|SET_TENSOR_PREQUEL]]
Line 169:		Line 169:
	\|-		\|-
	\|[[api session event editor overlay set visible\|SET_VISIBLE]]		\|[[api session event editor overlay set visible\|SET_VISIBLE]]
	\|Visualizes or hides an [[Overlay]] in the navigation ~~panel~~.		\|Visualizes or hides an [[Overlay]] in the navigation [[Panel]].
	\|-		\|-
	\|[[api session event editor overlay set water mode\|SET_WATER_MODE]]		\|[[api session event editor overlay set water mode\|SET_WATER_MODE]]
Line 175:		Line 175:
	\|-		\|-
	\|[[api session event editor overlay set water weather\|SET_WATER_WEATHER]]		\|[[api session event editor overlay set water weather\|SET_WATER_WEATHER]]
	\|Set a specified ~~weather~~ to serve as input for a specified water [[Overlay]].		\|Set a specified [[Weather]] to serve as input for a specified water [[Overlay]].
	\|-		\|-
	\|[[api session event editor overlay swap order\|SWAP_ORDER]]		\|[[api session event editor overlay swap order\|SWAP_ORDER]]
Line 187:		Line 187:
	\|-		\|-
	\|[[api session event editor overlay refresh grid\|REFRESH_GRID]]		\|[[api session event editor overlay refresh grid\|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.		\|Deprecated [[Function]]ality, 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.
	\|}		\|}
	{{article end\|seealso=*[[Api Events]]}}		{{article end\|seealso=*[[Api Events]]}}

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