Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
The functions exported on the API are summarized here:
WIP
---
...
below. Note that the only function applications should call is the register() function. The remaining functions are called by topology modules to integrate the overlay module with the rest of the topology view.
| Function | Description |
|---|---|
register | Main function that applications should call to register their overlay definition. |
setApi | Injects an internal API for accessing other topology modules. (internal use only). |
list | Lists the registered overlays. |
overlaysAcceptingIntents | Returns a list of overlays that support "intent rendering". |
augmentRbset | Utility function to add radio buttons to the topology toolbar - one for each overlay. |
mkGlyphId | Utility function to create a glyph identifier (expands '*' prefixes to the overlay identifier). |
tbSelection | Toolbar overlay button selection callback. |
installButtons | Installs action buttons on the detail panel. Usually just the core buttons, but this can include buttons defined by the currently active overlay. |
addDetailButton | Adds a button to the detail panel |
resetOnToolbarDestroy | Function to reset state when the toolbar is destroyed. |
showHighlights | Event handler for "showHighlights" event from the server. |
setLionBundle | Invoked by the framework to set the appropriate localization bundle. |
The following functions are specialized "hooks" for integrating callbacks for overlays (optionally) defined on the overlay definition.
hooks.{function} | Description |
|---|---|
escape | Invoked when the Escape key is pressed. |
emptySelect | Invoked when the user empties the "selection" (e.g. clicking on the topology background). |
singleSelect | Invoked when the user selects a single item (device, host) on the topology view. |
multiSelect | Invoked when the user selects multiple items (device, and/or hosts) on the topology view. |
mouseOver | Invoked when the user hovers the mouse over a node (device, host). |
mouseOut | Invoked when the user moves the mouse away from a node (device, host). |
showIntent | Invoked when the topology view is directed to render an intent (e.g. from the Intents view). |