This is an archive of the ONOS 1.2 wiki. For the current ONOS wiki, look here.

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.

ServiceDescription
FlashServiceAllows user to flash messages on the screen.
PanelServiceProvides an API to create and destroy panels.
QuickHelpServiceAllows user to display a quick help panel.
VeilServiceManages an overlay that appears when the websocket connection fails.

Mast

The module holding these services is onosMast and is in mast/mast.js.

ServiceDescription
MastServiceReturns the height of the mast in pixels.

Nav

The module holding these services is onosNav and is in nav/nav.js.

ServiceDescription
NavServiceManages the navigation pane.

Remote

The module holding these services is onosRemote and is in remote/remote.js.

ServiceDescription
RestServiceAbstracts rest calls using the $http service.
UrlFnServiceCreates URL strings for REST or Websocket calls.
WebSocketServiceHandles Websocket events (bind, unbind, listeners).
WsEventServiceSend events with the Websocket (used by other services).
WSockWeb socket wrapper.

SVG

The module holding these services is onosSvg and is in svg/svg.js.

ServiceDescription
GeoDataServiceFetches and caches TopoJSON data, provides a way of creating a path generator for that data.
GlyphServiceAdd, load, and register SVG symbols (glyphs).
IconServiceAdd, load, and register SVG icons (abstraction of GlyphService).
MapServiceLoads graphical maps into the SVG layer.
SvgUtilServiceGeneral SVG utility functions.
ZoomServiceCreates a "zoomer" to zoom in on SVG maps.

Util

The module holding these services is onosUtil and is in util/util.js.

ServiceDescription
FnServiceProvides general purpose functions that are useful throughout the application.
KeyServiceBind and enable keys to certain functions.
PrefsServiceStores user settings in the browser's cookies.

RandomService

Encapsulated randomness.
ThemeServiceManages theme add, remove, and toggle.

Widget

The module holding these services is onosWidget and is in widget/widget.js.

ServiceDescription
ButtonServiceProvides an API to create buttons, toggles, and radio button sets.
TableServiceHolds Angular directives for tabular views and allows user to reset sort direction for tables.
TableBuilderServiceBuilds a generic table view.
ToolbarServiceProvides an API to create a toolbar.
TooltipServiceProvides an API to install tooltips.
  • No labels