SimpleNode
since v0.8.0Interface representing the most basic node in the diagram
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends DataObject = DataObject
Properties
Section titled “Properties”angle?
Section titled “angle?”
optionalangle:number
The angle of the node from 0 to 360.
autoSize?
Section titled “autoSize?”
optionalautoSize:boolean
Whether the size of the node is automatically resized based on the content.
computedHidden?
Section titled “computedHidden?”
readonlyoptionalcomputedHidden:boolean
Remarks
Section titled “Remarks”ComputedHidden is computed by the system and should not be set manually.
The effective visibility of the node: true when its own hidden flag
or a template binding is set, or when any ancestor group is effectively
hidden.
1.4.0
computedZIndex?
Section titled “computedZIndex?”
readonlyoptionalcomputedZIndex:number
Remarks
Section titled “Remarks”ComputedZIndex is computed by the system and should not be set manually.
The final z-index applied to the DOM element for rendering order.
Computed from zOrder, group hierarchy, and selection elevation.
Children are always above their parent group.
data:
T
The data associated with the node.
draggable?
Section titled “draggable?”
optionaldraggable:boolean
Whether the node is draggable.
groupId?
Section titled “groupId?”
optionalgroupId:string
The id of the parent node.
hidden?
Section titled “hidden?”
optionalhidden:boolean
Whether the node is hidden. When not set, the node is visible.
A hidden node keeps its size and position and does not block
initialization or waitForMeasurements. User interactions ignore it:
hit-testing, select-all, box selection, keyboard move, drag, linking,
zoomToFit bounds and edge routing. In the default render mode the node
stays in the DOM with display: none. With virtualization enabled it is
removed from the DOM instead; its geometry stays in the model and is
measured again when the node becomes visible. Hiding a group hides all
of its descendants. Hiding a node hides the edges connected to it.
Programmatic APIs such as select, centerOnNode and the z-order
commands do not skip hidden elements. It is up to the caller whether to
use them on hidden elements.
Set by the user; the library only reads it.
computedHidden for the derived effective visibility.
1.4.0
id:
string
The unique identifier for the node.
measuredBounds?
Section titled “measuredBounds?”
readonlyoptionalmeasuredBounds:Rect
Remarks
Section titled “Remarks”MeasuredBounds are computed by the system and should not be set manually. Bounding box that encompasses the node including its ports, accounting for rotation.
measuredPorts?
Section titled “measuredPorts?”
readonlyoptionalmeasuredPorts:Port[]
Remarks
Section titled “Remarks”MeasuredPorts are computed by the system and should not be set manually. The ports of the node with computed position and size.
position
Section titled “position”position:
Point
The position of the node in the diagram.
resizable?
Section titled “resizable?”
optionalresizable:boolean
Whether the node is resizable.
rotatable?
Section titled “rotatable?”
optionalrotatable:boolean
Whether the node is rotatable.
selected?
Section titled “selected?”
optionalselected:boolean
Whether the node is selected.
optionalsize:Size
The size of the node.
optionaltype:string
The type of the node declared in nodeTemplateMap.
zOrder?
Section titled “zOrder?”
optionalzOrder:number
The z-order of the node. Controls relative ordering among nodes on the same hierarchy level. With proper values, it can also influence ordering across different hierarchy levels, since each nesting level adds +1 to the computed z-index per child.
- Root nodes: used directly as the base z-index (negative values allowed).
- Grouped nodes: acts as a minimum floor — cannot go below the parent’s z-index.
Set by bringToFront / sendToBack commands, or manually.
computedZIndex for the final rendered z-index.