Interface representing a group node in the diagram

Extends

• SimpleNode<T>

Type Parameters

T

T extends DataObject = DataObject

Properties

angle?

optional angle: number

The angle of the node from 0 to 360.

Inherited from

SimpleNode.angle

---

autoSize?

optional autoSize: boolean

Whether the size of the node is automatically resized based on the content.

Inherited from

SimpleNode.autoSize

---

computedHidden?

readonly optional computedHidden: boolean

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.

Since

1.4.0

Inherited from

SimpleNode.computedHidden

---

computedZIndex?

readonly optional computedZIndex: number

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

SimpleNode.computedZIndex

---

data

data: T

The data associated with the node.

Inherited from

SimpleNode.data

---

draggable?

optional draggable: boolean

Whether the node is draggable.

Inherited from

SimpleNode.draggable

---

groupId?

optional groupId: string

The id of the parent node.

Inherited from

SimpleNode.groupId

---

hidden?

optional hidden: 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.

See

computedHidden for the derived effective visibility.

Since

1.4.0

Inherited from

SimpleNode.hidden

---

highlighted

highlighted: boolean

Whether the group is highlighted. For example, when a node is being dragged over it.

---

id

id: string

The unique identifier for the node.

Inherited from

SimpleNode.id

---

isGroup

isGroup: true

Flag indicating the node is a group

---

measuredBounds?

readonly optional measuredBounds: Rect

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

SimpleNode.measuredBounds

---

measuredPorts?

readonly optional measuredPorts: Port[]

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

SimpleNode.measuredPorts

---

position

position: Point

The position of the node in the diagram.

Inherited from

SimpleNode.position

---

resizable?

optional resizable: boolean

Whether the node is resizable.

Inherited from

SimpleNode.resizable

---

rotatable?

optional rotatable: boolean

Whether the node is rotatable.

Inherited from

SimpleNode.rotatable

---

selected?

optional selected: boolean

Whether the node is selected.

Inherited from

SimpleNode.selected

---

size?

optional size: Size

The size of the node.

Inherited from

SimpleNode.size

---

type?

optional type: string

The type of the node declared in nodeTemplateMap.

Inherited from

SimpleNode.type

---

zOrder?

optional zOrder: 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.

See

computedZIndex for the final rendered z-index.

Inherited from

SimpleNode.zOrder