All Events
Application events are messages that are sent from the application and listened to, within the application, to perform actions and/or notify others of an event.
The application will listen for all of the events outlined in the table below. Additionally, the application will forward these events onto any parent or child iframes within OmniSpatial (such as, integrations).
Overview
| Event | Description |
|---|---|
| apply-panel-layout | Event fired to trigger action to apply a new panel layout |
| apply-display-settings | Event fired to trigger a change of display settings |
| add-panel-to-layout | Event fired to trigger action to add a panel to the current layout |
| remove-panel-from-layout | Event fired to trigger action to remove a panel from the current layout |
| replace-panel-in-layout | Event fired to trigger action to replace a panel with another |
| replace-panel-in-layout | Event fired to trigger action to replace a panel with anotherY |
| panel-layout-change | Event fired when the active panel layout is modified |
| layout-list-change | Event fired when the layout list data has changed. This could be due to favorites or layout overload changes |
| panel-layout-pop-out-closed | Event fired when a panel layout pop out window has been closed |
| set-map | Event fired to trigger setting the map |
| add-layer | Event fired to trigger adding a layer to the existing map |
| highlight | Event fired to highlight a target |
| un-highlight | Event fired to un-highlight a target |
| emphasize | Event fired to emphasize a target |
| go-to | Triggers action to go to location |
| show-side-menu-right-panel | Triggers action to show a panel on the right side menu |
| restrict-side-menu-left-panel | Triggers action to restrict the left side menu panel |
| select | Triggers action to select feature(s) within the application |
| select-from-map | Triggers action to select a feature from a map event |
| before-map-change | Event fired before the application's "map" instance is changed |
| map-change | Event fired when the map instance changed |
| trigger-resource-sync | Event fired to trigger a resource synchronization |
| get-directions | Event fired to kick-off the action of displaying directions |
| apply-overrides | Event fired to kick-off the action of overriding configuration within the application |
| app-bootstrapped | Event fired when the application has been bootstrapped |
| app-ready | Event fired once the application has initially loaded |
| app-login | Event fired when the user has been initially logged in |
| position-change | Emitted when the GPS position is changed |
| heading-change | Event fired to trigger action to apply a new panel layout |
| gps-position-change | Emitted when the GPS position is changed |
| panel-component-ready | Event fired when a panel component has loaded |
| panel-component-destroyed | Event fired when a panel component has been destroyed (closed) |
Event Details
panel-component-ready
The panel-component-ready event will be fired every time a new panel component has been loaded in Omni (and is ready).
NOTE: panel components are configurable and users can remove and add components as they desire. Subsequently, this event can be triggered many times in a session.
panel-component-destroyed
The panel-component-destroyed event will be fired every time that a panel component is closed/destroyed.