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.
Overview
The ONOS Web GUI has been designed to facilitate the runtime injection of additional content by ONOS applications. There are two possible approaches:
- Register a "UI Extension" that adds one or more custom views
- See the Custom View tutorial
- See the Tabular View tutorial
- Register a "UI Extension" that adds a "Topology Overlay" component, augmenting the behavior of the Topology View
- See the Topology Overlay tutorial
- Register a 'UI Extension' that adds a "Topology Map" asset to the Topology View
- See the Add Maps Tutorial
As much as possible, reusable code has been made available to the developer, both for client-side code (JavaScript) and server-side code (Java).
Client-side Framework Libraries
Many useful framework modules are available to use in JavaScript. See the Web UI - Client side framework libraries page for details.
Server-side Model and Utility Classes
A number of helper classes are available to use in server-side code. See the Web UI - Server side helper classes page for details.
Further Topics
to be documented
- Some notes on conventions and assumptions
- Websocket communication
- Defining key-bindings
- Creating and using "fly-in" panels
- Defining custom "glyphs"