This page describes the JavaScript API that the Topology View provides to allow contributed application code to integrate with, and provide additional functionality to, the topology view.

Note that this API pertains to the "Classic" Topology View (topo).

Topology Overlay Service

The Topology Overlay Service is a JavaScript module that provides the client-side API for registering new "topology overlay" components.

The functions exported on the API are summarized here:

WIP

---

return {
    register: register,
    setApi: setApi,
    list: list,
    overlaysAcceptingIntents: overlaysAcceptingIntents,
    augmentRbset: augmentRbset,
    mkGlyphId: mkGlyphId,
    tbSelection: tbSelection,
    installButtons: installButtons,
    addDetailButton: addDetailButton,
    resetOnToolbarDestroy: function () { reset = true; },
    hooks: {
        escape: escapeHook,
        emptySelect: emptySelectHook,
        singleSelect: singleSelectHook,
        multiSelect: multiSelectHook,
        mouseOver: mouseOverHook,
        mouseOut: mouseOutHook,
        showIntent: showIntentHook,
    },

    showHighlights: showHighlights,
    setLionBundle: setLionBundle,
};