Home > @i2analyze/notebook-sdk > visual > IElementBase
visual.IElementBase interface
A set of information and functionality that is common to all elements on an i2 Notebook chart.
Signature:
interface IElementBase
Introduced: version 1.0
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
id | readonly |
ElementId | Gets the identifier of the element. |
labelOrFallback | readonly |
string | Gets the label of the element or, if there is no label, an application-standard fallback string such as '<No label>'. |
records | readonly |
data.IKeyedReadOnlyCollection<records.AnalyzeRecordId, records.IChartRecord> | Gets the records that the element represents, indexed by their identifiers. |
Methods
Method | Description |
---|---|
getLabelDetails() | Gets the label for the element, together with information about whether the label has a genuine value. |
isEdge() | Tests whether the element is an edge; functions as a TypeScript typeguard. |
isNode() | Tests whether the element is a node; functions as a TypeScript typeguard. |