Api session event editor overlay: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editoroverlay/ | <noinclude lang="text" copy>API Endpoint: api/session/event/editoroverlay/ | ||
</noinclude><noinclude lang="text" copy> | |||
API | API Endpoints for [[Overlay]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
| [[Api session event editor overlay add|add]] | | [[Api session event editor overlay add|add]] | ||
| Add a new [[Overlay]] of the specified type | | Add a new [[Overlay]] of the specified type | ||
|- | |- | ||
| [[Api session event editor overlay append attribute|append_attribute]] | | [[Api session event editor overlay append attribute|append_attribute]] | ||
| 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]]s | ||
|- | |- | ||
| [[Api session event editor overlay remove attribute|remove_attribute]] | | [[Api session event editor overlay remove attribute|remove_attribute]] | ||
| Remove the specified [[Attribute]]s of the specified [[Overlay]]. The [[Attribute]]s, including [[Attribute]]s which are added to an [[Overlay]] by default, are removed entirely | | Remove the specified [[Attribute]]s of the specified [[Overlay]]. The [[Attribute]]s, including [[Attribute]]s 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 28: | Line 28: | ||
|- | |- | ||
| [[Api session event editor overlay set name|set_name]] | | [[Api session event editor overlay set name|set_name]] | ||
| Set the name | | Set the name of an [[Overlay]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
| [[Api session event editor overlay add | | [[Api session event editor overlay add difference entry|add_difference_entry]] | ||
| Add | | Add an entry to the difference legend an [[Overlay]] | ||
|- | |||
| [[Api session event editor overlay add entry|add_entry]] | |||
| Add an entry to the legend an [[Overlay]] | |||
|- | |- | ||
| [[Api session event editor overlay add overlay function|add_overlay_function]] | | [[Api session event editor overlay add overlay function|add_overlay_function]] | ||
| Add a | | Add a [[Function]] to a [[Function]] [[Overlay]] | ||
|- | |- | ||
| [[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 | | Add a specified [[Result type]] as a Result Child [[Overlay]] to a Result Parent [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay add type|add_type]] | | [[Api session event editor overlay add type|add_type]] | ||
| Add | | Add an [[Overlay]] with the specified type | ||
|- | |- | ||
| [[Api session event editor overlay remove | | [[Api session event editor overlay remove difference entry|remove_difference_entry]] | ||
| Remove | | Remove entries from an [[Overlay]]'s difference legend | ||
|- | |||
| [[Api session event editor overlay remove entry|remove_entry]] | |||
| Remove entries from an [[Overlay]]'s legend | |||
|- | |- | ||
| [[Api session event editor overlay remove overlay function|remove_overlay_function]] | | [[Api session event editor overlay remove overlay function|remove_overlay_function]] | ||
| Remove a | | Remove a [[Function]] from a [[Function]] Highlight [[Overlay]] | ||
|- | |- | ||
| [[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]] | ||
| Remove Water [[ | | Remove the [[Weather]] from a Water [[Overlay]] | ||
|- | |- | ||
| [[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]] | | Create a deactivated copy of each specified [[Overlay]] | ||
|- | |- | ||
| [[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]] | | Set which [[Attribute]] an [[Attribute]] [[Overlay]] uses to obtain the color from an [[Item]] to paint it with. 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]] | | Set which type of [[Item]] and which [[Attribute]] an [[Attribute]] [[Overlay]] should highlight | ||
|- | |- | ||
| [[Api session event editor overlay set avg distance|set_avg_distance]] | | [[Api session event editor overlay set avg distance|set_avg_distance]] | ||
| Set the averaging distance for | | Set the averaging distance for an Average [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set combo formula|set_combo_formula]] | | [[Api session event editor overlay set combo formula|set_combo_formula]] | ||
| Set formula for a Combo [[Overlay]] | | Set formula for a Combo [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set custom legend|set_custom_legend]] | | [[Api session event editor overlay set custom legend|set_custom_legend]] | ||
| Set whether | | Set whether an [[Overlay]] has a custom legend. If set to false, its legends are reverted to a generated default | ||
|- | |||
| [[Api session event editor overlay set difference entry color|set_difference_entry_color]] | |||
| Set the color of an entry of an [[Overlay]]'s difference legend | |||
|- | |||
| [[Api session event editor overlay set difference entry name|set_difference_entry_name]] | |||
| Set the name of an entry of an [[Overlay]]'s difference legend | |||
|- | |||
| [[Api session event editor overlay set difference entry value|set_difference_entry_value]] | |||
| Set the value of an entry of an [[Overlay]]'s difference legend | |||
|- | |- | ||
| [[Api session event editor overlay set discharge method|set_discharge_method]] | | [[Api session event editor overlay set discharge method|set_discharge_method]] | ||
| Set Discharge Method | | Set the Discharge Method of a Watershed [[Overlay]] | ||
|- | |||
| [[Api session event editor overlay set entry color|set_entry_color]] | |||
| Set the color of an entry of an [[Overlay]]'s legend | |||
|- | |||
| [[Api session event editor overlay set entry name|set_entry_name]] | |||
| Set the name of an entry of an [[Overlay]]'s legend | |||
|- | |||
| [[Api session event editor overlay set entry value|set_entry_value]] | |||
| Set the value of an entry of an [[Overlay]]'s legend | |||
|- | |- | ||
| [[Api session event editor overlay set geotiff|set_geotiff]] | | [[Api session event editor overlay set geotiff|set_geotiff]] | ||
| | | Set 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]] | ||
| | | Set a [[Grid Overlay]] active or inactive. Only active [[Overlay]]s 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]] | ||
| Set Heat Model | | Set the Heat Model of a Heat Stress [[Overlay]] | ||
|- | |- | ||
| [[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]] | | Change the icon displayed in the navigation window by the [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set key value|set_key_value]] | | [[Api session event editor overlay set key value|set_key_value]] | ||
| | | Set a key to an [[Attribute]] for a [[Grid Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set net overlay|set_net_overlay]] | | [[Api session event editor overlay set net overlay|set_net_overlay]] | ||
| Set the visualization style for a | | Set the visualization style for a Network [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set neural network|set_neural_network]] | | [[Api session event editor overlay set neural network|set_neural_network]] | ||
| Set the [[Neural Network]] for an Inference [[Overlay]] | | Set the [[Neural Network]] for an Inference [[Overlay]] | ||
|- | |- | ||
| [[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 | | Add or remove [[Area]]s to or from an [[Area]] [[Overlay]] | ||
|- | |- | ||
| [[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 | | Change the image displayed by an Image [[Overlay]] | ||
|- | |- | ||
| [[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]] | ||
| Set the color a | | Set the color of a [[Function]] or [[Attribute]] [[Overlay]], used to highlight features | ||
|- | |- | ||
| [[Api session event editor overlay set overlay remainder color|set_overlay_remainder_color]] | | [[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 | | 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]] | | [[Api session event editor overlay set overlay source|set_overlay_source]] | ||
| Add or remove | | Add or remove specific [[Source]]s to or from a [[Source]] [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set parent|set_parent]] | | [[Api session event editor overlay set parent|set_parent]] | ||
| Set a parent [[Overlay]] for | | Set a parent [[Overlay]] for an [[Overlay]]. An [[Overlay]] with a parent cannot be assigned as a parent to another [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set prequel|set_prequel]] | | [[Api session event editor overlay set prequel|set_prequel]] | ||
| Set | | Set Prequel [[Overlay]] for a [[Grid Overlay]] and a Prequel Type supported by the [[Grid Overlay]]. Optionally a specific [[Timeframe]] is used to obtain [[Grid]] values, with the last [[Timeframe]] of the Prequel [[Overlay]] as defaultOptionally [[Grid]] Values are obtain from a previous [[Simulation Core|Iteration]], allowing cyclic dependencies between [[Grid Overlay]]s | ||
|- | |- | ||
| [[Api session event editor overlay set rasterization|set_rasterization]] | | [[Api session event editor overlay set rasterization|set_rasterization]] | ||
| Set the type of rasterization a | | Set the type of rasterization used by a Average, Combo or Distance [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set result type|set_result_type]] | | [[Api session event editor overlay set result type|set_result_type]] | ||
| Set the [[Result type]] of a | | Set the [[Result type]] of a [[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]] | | [[Api session event editor overlay set service crs|set_service_crs]] | ||
| Set the preferred CRS for the Service [[Source]] of a specified Service [[Overlay]] | | Set the preferred 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 preferred option to force the CRS order to longitude/latitude for the Service [[Source]] of a specified Service [[Overlay]] | | Set the preferred 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 [[Timeframe]] | ||
|- | |- | ||
| [[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]] | ||
| Set whether a | | Set whether a [[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 | | Set whether a Water [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center [[Point]]s 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]] | ||
| Set the Inference Prequel for an input tensor of an Inference [[Overlay]] | | 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]] | | [[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]] | | 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]] | | [[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]] | | Set the Value Type for an input tensor of an Inference [[Overlay]] | ||
|- | |- | ||
| [[Api session event editor overlay set visible|set_visible]] | | [[Api session event editor overlay set visible|set_visible]] | ||
| | | Set whether an [[Overlay]] is visualized 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]] | ||
| Set Water Mode | | Set the Water Mode of a Water [[Overlay]] | ||
|- | |- | ||
| [[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 | | 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]] | ||
| Swap | | Swap the order of paired [[Overlay]]s | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items overlays]] | *[[Api session items overlays]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:26, 13 November 2026
API Endpoint: api/session/event/editoroverlay/
API Endpoints for Overlay editing.
| Name | Description |
|---|---|
| add | Add a new Overlay of the specified type |
| append_attribute | Appended to existing Overlay numeric Attribute value |
| duplicate | Duplicate existing Overlay |
| remove | Remove the specified Overlays |
| 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 numeric Attribute value |
| set_attributes | Set multiple Overlay numeric Attribute values |
| set_name | Set the name of an Overlay |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_difference_entry | Add an entry to the difference legend an Overlay |
| add_entry | Add an entry to the legend an Overlay |
| add_overlay_function | Add a Function to a Function Overlay |
| add_result_child | Add a specified Result type as a Result Child Overlay to a Result Parent Overlay |
| add_type | Add an Overlay with the specified type |
| remove_difference_entry | Remove entries from an Overlay's difference legend |
| remove_entry | Remove entries from an Overlay's legend |
| remove_overlay_function | Remove a Function from a Function Highlight Overlay |
| remove_prequel | Remove a Grid Overlay's prequel Overlay |
| remove_water_weather | Remove the Weather from a Water Overlay |
| save_grid | Create a deactivated copy of each specified Overlay |
| set_attribute_overlay_color_attribute | Set which Attribute an Attribute Overlay uses to obtain the color from an Item to paint it with. If absent, the Overlay's color will be used |
| set_attribute_overlay_values | Set which type of Item and which Attribute an Attribute Overlay should highlight |
| set_avg_distance | Set the averaging distance for an Average Overlay |
| set_combo_formula | Set formula for a Combo Overlay |
| set_custom_legend | Set whether an Overlay has a custom legend. If set to false, its legends are reverted to a generated default |
| set_difference_entry_color | Set the color of an entry of an Overlay's difference legend |
| set_difference_entry_name | Set the name of an entry of an Overlay's difference legend |
| set_difference_entry_value | Set the value of an entry of an Overlay's difference legend |
| set_discharge_method | Set the Discharge Method of a Watershed Overlay |
| set_entry_color | Set the color of an entry of an Overlay's legend |
| set_entry_name | Set the name of an entry of an Overlay's legend |
| set_entry_value | Set the value of an entry of an Overlay's legend |
| set_geotiff | Set the GeoTIFF displayed by a specified GeoTIFF Overlay |
| set_grid_active | Set a Grid Overlay active or inactive. Only active Overlays are recalculated by the Simulation |
| set_heat_model | Set the Heat Model of a Heat Stress Overlay |
| set_image | Change the icon displayed in the navigation window by the Overlay |
| set_key_value | Set a key to an Attribute for a Grid Overlay |
| set_net_overlay | Set the visualization style for a Network Overlay |
| set_neural_network | Set the Neural Network for an Inference Overlay |
| set_overlay_area | Add or remove Areas to or from an Area Overlay |
| set_overlay_image | Change the image displayed by an Image Overlay |
| set_overlay_primary_color | Set the color of a Function or Attribute Overlay, used to highlight features |
| 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 specific Sources to or from a Source Overlay |
| set_parent | Set a parent Overlay for an Overlay. An Overlay with a parent cannot be assigned as a parent to another Overlay |
| set_prequel | Set Prequel Overlay for a Grid Overlay and a Prequel Type supported by the Grid Overlay. Optionally a specific Timeframe is used to obtain Grid values, with the last Timeframe of the Prequel Overlay as defaultOptionally Grid Values are obtain from a previous Iteration, allowing cyclic dependencies between Grid Overlays |
| set_rasterization | Set the type of rasterization used by a Average, Combo or Distance Overlay |
| set_result_type | Set the Result type of a 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 preferred CRS for the Service Source of a specified Service Overlay |
| set_service_force_xy | Set the preferred 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 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 Water Overlay visualizes the graph of systems which dictates its calculation. Pipes, center Points of Areas, 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 | Set whether an Overlay is visualized in the Navigation Panel |
| set_water_mode | Set the Water Mode of a Water Overlay |
| set_water_weather | Set a specified Weather to serve as input for a specified Water Overlay |
| swap_order | Swap the order of paired Overlays |