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 below. Note that the only function applications should call is only be invoking the register() function. The remaining functions are called by topology modules to integrate the overlay module documented here for reference only; they provide the integration of overlay modules with the rest of the topology view.
...
The following functions are specialized "hooks" for integrating callbacks for overlays (optionally) defined on the overlay definition.
If an overlay definition includes hook functions of the same name, those callbacks will be invoked at the appropriate times, whenever the overlay is currently active.
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). |
...