Home > @i2analyze/notebook-sdk > visual > IBadgeIcon
visual.IBadgeIcon interface
A badge icon displayed alongside a node or edge in one of six slot positions.
Signature:
interface IBadgeIcon extends data.IImage
Extends: data.IImage
Introduced: version 1.10
Remarks
Extends data.IImage, so href and description follow the same convention as visual.INodeStyle.image. description is required but may be the empty string.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description |
readonly
| string | Gets a description of the image to use as alternative text, for example. (Inherited from IImage) |
| href |
readonly
| string | Gets the URL of the image. (Inherited from IImage) |
| slot |
readonly
| BadgeSlot | Gets the slot position of the badge. |