Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameSummary
loadIconCreates an icon with the given glyph ID.
loadIconByClassCreate an icon with the given icon lookup. This function provides more options than loadEmbeddedIcon.
loadEmbeddedIconCreate an icon with the given icon lookup.
addDeviceIconAdds a device icon to the given element.
addHostIconAdds a host icon to the given element.
iconConfigReturns the configuration for device and host icons in the Topology View.
sortIconsReturns an API (used in Tabular views) for adding ascending and descending icons, and removing them.

registerIconMapping

Registers an icon-to-glyph mapping.

Directive

NameOther AttributesSummary
iconicon-id, icon-sizeCreates an icon in the HTML element with the given ID of the given size.

...

Example UsageArgumentsReturn Value
var sortAPI = is.sortIcons();nonean object containing an API (see below)
Returned API Example UsageArgumentsReturn Value
sortAPI.sortAsc(div);div - d3 selection of the div where the icon should be loadedcreates an up arrow for ascending sort direction, no return value
sortAPI.sortDesc(div);div - d3 selection of the div where the icon should be loadedcreates a down arrow for ascending sort direction, no return value
sortAPI.sortNone(div);div - d3 selection of the div that contains the icon that should be removedremoves the contents of div, no return value

registerIconMapping

Registers an icon-to-glyph mapping 

Example UsageArgumentsReturn Value

is.registerIconMapping(iconId, glyphId);

iconId - the new icon ID to be added to the map

glyphId - the ID of a glyph in the glyph library

None

Directive

icon

Icons are also able to be loaded into HTML elements through an Angular directive.

...