Api session event editor: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API api session event editor Events. Generic Editor events for creating a Project and updating. {|class=wikitable !Name !Description |- |ACTIVATE_TESTRUN |Start or stop a Scenario Testrun. |- |CLEAR_MAP |Remove all geospatial data of the Project, such as buildings, areas, etc. |- |SET_INITIAL_MAP_SIZE |Set the size of the map. Thi..."
 
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
API api session event editor Events.
Api session event editor Endpoints.


Generic Editor events for creating a Project and updating.
API Endpoints for Generic Editor endpoints for creating a Project and updating.
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[api session event editor activate testrun|ACTIVATE_TESTRUN]]
|[[Api session event editor activate testrun|activate_testrun]]
|Start or stop a [[Scenario]] Testrun.
|Start or stop a [[Scenario]] Testrun.
|-
|-
|[[api session event editor clear map|CLEAR_MAP]]
|[[Api session event editor clear map|clear_map]]
|Remove all geospatial data of the Project, such as buildings, areas, etc.
|Remove all geospatial data of the Project, such as [[Building]], [[Area]], etc.
|-
|-
|[[api session event editor set initial map size|SET_INITIAL_MAP_SIZE]]
|[[Api session event editor set initial map size|set_initial_map_size]]
|Set the size of the map. This can only be done once.
|Set the size of the map. This can only be done once.
|-
|-
|[[api session event editor set scheduled update|SET_SCHEDULED_UPDATE]]
|[[Api session event editor set scheduled update|set_scheduled_update]]
|Schedule a long-running update of all active overlays, indicators, panels and triggers.
|Schedule a long-running update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]].
|-
|-
|[[api session event editor start map creation|START_MAP_CREATION]]
|[[Api session event editor start map creation|start_map_creation]]
|Set the Project's georeference center point to the provided coordinates and begin the process of automatically load in available data.
|Set the Project's georeference center point to the provided coordinates and begin the process of automatically load in available data.
|-
|-
|[[api session event editor update|UPDATE]]
|[[Api session event editor update|update]]
|Waits for update of all active overlays, indicators, panels and triggers. Note: for long-running updates use: set_scheduled_update/ to schedule an update.
|Calculate all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update.
|-
|-
|[[api session event editor update with id|UPDATE_WITH_ID]]
|[[Api session event editor update with id|update_with_id]]
|Waits for update of all active overlays, indicators, panels and triggers with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update.
|Waits for update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update.
|}
|}
{{article end|seealso=*[[Api Events]]}}
{{article end|seealso=*[[Api Events]]
}}


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

Latest revision as of 08:19, 29 May 2026

Api session event editor Endpoints.

API Endpoints for Generic Editor endpoints for creating a Project and updating.

Name Description
activate_testrun Start or stop a Scenario Testrun.
clear_map Remove all geospatial data of the Project, such as Building, Area, etc.
set_initial_map_size Set the size of the map. This can only be done once.
set_scheduled_update Schedule a long-running update of all active Overlay, Indicator, Panel and Trigger.
start_map_creation Set the Project's georeference center point to the provided coordinates and begin the process of automatically load in available data.
update Calculate all active Overlay, Indicator, Panel and Trigger and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update.
update_with_id Waits for update of all active Overlay, Indicator, Panel and Trigger with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update.

See also