Api session event editor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
|[[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 | |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 | |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]] | ||
| Line 22: | Line 22: | ||
|- | |- | ||
|[[api session event editor update|UPDATE]] | |[[api session event editor update|UPDATE]] | ||
|Waits for update of all active | |Waits for update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s. Note: for long-running updates 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 | |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]]}} | ||
[[Category:API]] | [[Category:API]] | ||
Revision as of 14:09, 30 March 2026
API api session event editor Events.
Generic Editor events 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 | Waits for update of all active Overlays, Indicators, Panels and Triggers. Note: for long-running updates 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. |