Api session event editor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Api session event editor Endpoints. | Api session event editor Endpoints. | ||
API | API End[[#Api Model Point|Point]]s for Generic Editor end[[#Api Model Point|Point]]s for creating a Project and updating. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 10: | Line 10: | ||
|- | |- | ||
|[[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 [[Building]], [[Area]], etc. | |Remove all geospatial data of the Project, such as [[Building]]s, [[Area]]s, 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]] | ||
| Line 16: | Line 16: | ||
|- | |- | ||
|[[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 [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]]. | |Schedule a long-running update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s. | ||
|- | |- | ||
|[[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 | |Set the Project's georeference center [[#Api Model Point|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]] | ||
|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. | |Calculate all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s 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 [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update. | |Waits for update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s 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]] | ||
Revision as of 14:43, 2 June 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 Buildings, Areas, 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 Overlays, Indicators, Panels and Triggers. |
| 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 Overlays, Indicators, Panels and Triggers 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 Overlays, Indicators, Panels and Triggers with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update. |