Home > @i2analyze/notebook-sdk > visual > IEdge
visual.IEdge interface
An edge on a chart surface.
Signature:
interface IEdge extends IElementBase
Extends: IElementBase
Introduced: version 1.0
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| direction | readonly |
data.LinkDirection | Gets the direction of the edge. |
| fromEnd | readonly |
INode | Gets the node at the 'from' end of the edge. |
| id | readonly |
ElementId | Gets the identifier of the element. (Inherited from IElementBase) |
| labelOrFallback | readonly |
string | Gets the label of the element or, if there is no label, an application-standard fallback string such as '<No label>'. (Inherited from IElementBase) |
| records | readonly |
data.IKeyedReadOnlyCollection<records.AnalyzeRecordId, records.IChartRecord> | Gets the records that the element represents, indexed by their identifiers. (Inherited from IElementBase) |
| style | readonly |
IEdgeStyle | Gets the style of the edge, which affects its appearance. |
| toEnd | readonly |
INode | Gets the node at the 'to' end of the edge. |
Methods
| Method | Description |
|---|---|
| getLabelDetails() | Gets the label for the element, together with information about whether the label has a genuine value. (Inherited from IElementBase) |
| isEdge() | Tests whether the element is an edge; functions as a TypeScript typeguard. (Inherited from IElementBase) |
| isNode() | Tests whether the element is a node; functions as a TypeScript typeguard. (Inherited from IElementBase) |