Api session event editor overlay: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Api session event editor overlay Endpoints. | Api session event editor overlay Endpoints. | ||
API | API End[[#Api Model Point|Point]]s for [[Overlay]] editing. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 10: | Line 10: | ||
|- | |- | ||
|[[Api session event editor overlay append attribute|append_attribute]] | |[[Api session event editor overlay append attribute|append_attribute]] | ||
|Appended to existing [[Overlay]] | |Appended to existing [[Overlay]] [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor overlay duplicate|duplicate]] | |[[Api session event editor overlay duplicate|duplicate]] | ||
| Line 16: | Line 16: | ||
|- | |- | ||
|[[Api session event editor overlay remove|remove]] | |[[Api session event editor overlay remove|remove]] | ||
|Remove the specified [[Overlay]]. | |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 | |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]] | ||
|Set [[Overlay]] | |Set [[Overlay]] [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor overlay set attributes|set_attributes]] | |[[Api session event editor overlay set attributes|set_attributes]] | ||
|Set multiple [[Overlay]] | |Set multiple [[Overlay]] [[Attribute]] values | ||
|- | |- | ||
|[[Api session event editor overlay set name|set_name]] | |[[Api session event editor overlay set name|set_name]] | ||
| Line 31: | Line 31: | ||
|} | |} | ||
Additional API | Additional API End[[#Api Model Point|Point]]s: | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| 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 | |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]] | ||
|Add a specified | |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]] of the specified types. | |Add multiple new [[Overlay]]s 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]] | ||
| 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 | |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]] | ||
|Remove a | |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]] and | |Create a copy of each specified [[Overlay]]. The copies will have the same [[Setting]]s and [[Attribute]]s, 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 | |Set which [[Attribute]] a specified [[Attribute]] [[Overlay]] should use to color the [[Item]]s 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 | |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 [[Map Type]] 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 | |Set whether the specified [[Overlay]] has a custom legend. If the specified [[Overlay]] is reverted to use a default [[Overlay]], any custom legend in[[Format]]ion 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 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 [[Overlay]] are recalculated by the simulation. | |Activates or deactivates an [[Overlay]]. 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]] | ||
| 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]] 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]] | ||
|Change a key for a specified [[Overlay]]. The [[Overlay]] must be an [[Overlay]] which makes use of keys to read | |Change a key for a specified [[Overlay]]. The [[Overlay]] must be an [[Overlay]] which makes use of keys to read [[Attribute]]s of geographical [[Item]]s, 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]] to or from a specified [[Area]] [[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. | |Add or remove specified [[Area]]s to or from a specified [[Area]]s [[Overlay]]. Unincluded [[Area]]s which are already related to the [[Overlay]] will remain related. Unincluded [[Area]]s 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]] | ||
|Change the image displayed by a specified IMAGE [[Overlay]]. The image must be uploaded in the "[[Overlay]]" directory. | |Change the image displayed by a specified IMAGE [[Overlay]]. The image must be uploaded in the "[[Overlay]]s" 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]] | ||
|Set the color a specified | |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]] | |[[Api session event editor overlay set overlay remainder color|set_overlay_remainder_color]] | ||
|Set the color a specified | |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 specified [[Source]] to or from a specified | |Add or remove specified [[Source]]s to or from a specified [[Source]] [[Overlay]]. Unincluded [[Source]]s which are already related to the [[Overlay]] will remain related. Unincluded [[Source]]s 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 133: | Line 133: | ||
|- | |- | ||
|[[Api session event editor overlay set rasterization|set_rasterization]] | |[[Api session event editor overlay set rasterization|set_rasterization]] | ||
|Set the type of rasterization a specified | |Set the type of rasterization a specified Average, Combo or Distance [[Overlay]] should do. | ||
|- | |- | ||
|[[Api session event editor overlay set result type|set_result_type]] | |[[Api session event editor overlay set result type|set_result_type]] | ||
|Set the | |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]] | |[[Api session event editor overlay set service crs|set_service_crs]] | ||
| Line 145: | Line 145: | ||
|- | |- | ||
|[[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 | |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]] | ||
| 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 | |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 | |Set whether a specified [[Overlay]] visualizes the graph of systems which dictates its calculation. Pipes, center [[#Api Model Point|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]] | ||
Revision as of 14:47, 2 June 2026
Api session event editor overlay Endpoints.
API EndPoints for 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 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 Attribute value |
| set_attributes | Set multiple Overlay Attribute values |
| set_name | Set the name for a specified Overlay. |
Additional API EndPoints:
| 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 Overlays 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 Settings 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 Map Type 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 Overlays 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 Assets 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 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. |
| set_overlay_image | Change the image displayed by a specified IMAGE Overlay. The image must be uploaded in the "Overlays" 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 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. |
| 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 Average, Combo 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 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 | 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 |