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
There are a number of Angular-based services that the ONOS GUI comes with ready made. All of our services are actually factories. Below you will find short summaries of what each service provides and links to pages with more information.
All of these services are in the directory web/gui/src/main/webapp/app/fw/.
Layer
The module holding these services is onosLayer and is in layer/layer.js.
| Service | Description |
|---|---|
| FlashService | Allows user to flash messages on the screen. |
| PanelService | Provides an API to create and destroy panels. |
| QuickHelpService | Allows user to display a quick help panel. |
| VeilService | Manages an overlay that appears when the websocket connection fails. |
Mast
The module holding these services is onosMast and is in mast/mast.js.
| Service | Description |
|---|---|
| MastService | Returns the height of the mast in pixels. |
Nav
The module holding these services is onosNav and is in nav/nav.js.
| Service | Description |
|---|---|
| NavService | Manages the navigation pane. |
Remote
The module holding these services is onosRemote and is in remote/remote.js.
| Service | Description |
|---|---|
| RestService | Abstracts rest calls using the $http service. |
| UrlFnService | Creates URL strings for REST or Websocket calls. |
| WebSocketService | Handles Websocket events (bind, unbind, listeners). |
| WsEventService | Send events with the Websocket (used by other services). |
| WSock | Web socket wrapper. |
SVG
The module holding these services is onosSvg and is in svg/svg.js.
| Service | Description |
|---|---|
| GeoDataService | Fetches and caches TopoJSON data, provides a way of creating a path generator for that data. |
| GlyphService | Add, load, and register SVG symbols (glyphs). |
| IconService | Add, load, and register SVG icons (abstraction of GlyphService). |
| MapService | Loads graphical maps into the SVG layer. |
| SvgUtilService | General SVG utility functions. |
| ZoomService | Creates a "zoomer" to zoom in on SVG maps. |
Util
The module holding these services is onosUtil and is in util/util.js.
| Service | Description |
|---|---|
| FnService | Provides general purpose functions that are useful throughout the application. |
| KeyService | Bind and enable keys to certain functions. |
| PrefsService | Stores user settings in the browser's cookies. |
RandomService | Encapsulated randomness. |
| ThemeService | Manages theme add, remove, and toggle. |
Widget
The module holding these services is onosWidget and is in widget/widget.js.
| Service | Description |
|---|---|
| ButtonService | Provides an API to create buttons, toggles, and radio button sets. |
| TableService | Allows user to reset sort icons created by the directives written for tables. |
| TableBuilderService | Builds a generic table view. |
| ToolbarService | Provides an API to create a toolbar. |
| TooltipService | Provides an API to install tooltips. |