Api session event editor overlay

From Tygron Support wiki
Revision as of 10:26, 13 November 2026 by Frank@tygron.nl (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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