Topology 2 API Documentation

This directory contains README files for each of the services defined in the Topology 2 View, documenting the APIs.

README.background.md - maps and sprite layouts management

README.badge.md - node badging

README.breadcrumb.md - region navigation breadcumbs

README.collection.md - generic collections of things

README.detailsPanel.md - generic details panel functions

README.device.md - device node functions

README.deviceDetailsPanel.md - device panel functions

README.event.md - event handling

README.force.md - force layout functions

README.host.md - host node functions

README.hostsPanel.md - host panel functions

README.instance.md - ONOS instance panel functions

README.keyCommands.md - keyboard commands

README.label.md - label handling

README.labelCollection.md - a collection of labels

README.layout.md - layout functions

README.link.md - link functions

README.linkLabel.md - handling link labels

README.linkPanel.md - detail panel for links

README.map.md - geo map service

README.mapConfig.md - geo map configuration

README.mastership.md - mastership highlighting

README.model.md - internal modeling of topology

README.nodeModel.md - node modeling

README.nodePosition.md - functions for positioning nodes

README.noDevicesConnected.md - no devices rendering

README.overlay.md - overlay service

README.panel.md - basic panel service

README.peerRegion.md - peer region handling

README.prefs.md - user preferences service

README.region.md - region nodes

README.regionNavigation.md - region navigation functions

README.select.md - selection model

README.spriteLayer.md - sprite layer rendering

README.subRegion.md - rendering sub regions

README.subRegionPanel.md - detail panel for selected region

README.summaryPanel.md - summary panel rendering

README.toolbar.md - toolbar rendering

README.traffic.md - traffic business logic

README.trafficOverlay.md - traffic overlay definition

README.view.md - view state variables

README.viewController.md - view controller base class

README.zoom.md - zoom event handler