GroupNode
since v0.8.0Interface representing a group node in the diagram
Extends
Section titled “Extends”SimpleNode<T>
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.
Inherited from
Section titled “Inherited from”autoSize?
Section titled “autoSize?”
optionalautoSize:boolean
Whether the size of the node is automatically resized based on the content.
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”data:
T
The data associated with the node.
Inherited from
Section titled “Inherited from”draggable?
Section titled “draggable?”
optionaldraggable:boolean
Whether the node is draggable.
Inherited from
Section titled “Inherited from”groupId?
Section titled “groupId?”
optionalgroupId:string
The id of the parent node.
Inherited from
Section titled “Inherited from”highlighted
Section titled “highlighted”highlighted:
boolean
Whether the group is highlighted. For example, when a node is being dragged over it.
id:
string
The unique identifier for the node.
Inherited from
Section titled “Inherited from”isGroup
Section titled “isGroup”isGroup:
true
Flag indicating the node is a group
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.
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”position
Section titled “position”position:
Point
The position of the node in the diagram.
Inherited from
Section titled “Inherited from”resizable?
Section titled “resizable?”
optionalresizable:boolean
Whether the node is resizable.
Inherited from
Section titled “Inherited from”rotatable?
Section titled “rotatable?”
optionalrotatable:boolean
Whether the node is rotatable.
Inherited from
Section titled “Inherited from”selected?
Section titled “selected?”
optionalselected:boolean
Whether the node is selected.
Inherited from
Section titled “Inherited from”
optionalsize:Size
The size of the node.
Inherited from
Section titled “Inherited from”
optionaltype:string
The type of the node declared in nodeTemplateMap.
Inherited from
Section titled “Inherited from”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.