The NgDiagramGroupsService provides methods for managing node groups in the diagram.

Example usage

private groupsService = inject(NgDiagramGroupsService);

// Add nodes to a group
this.groupsService.addToGroup('groupId', ['nodeId1', 'nodeId2']);

Extends

• NgDiagramBaseService

Methods

addToGroup()

addToGroup(groupId, nodeIds): Promise<void>

Adds nodes to a group.

Parameters

groupId

string

The ID of the group to add nodes to.

nodeIds

string[]

Array of node IDs to add to the group.

Returns

Promise<void>

A promise that resolves once the change has been applied to the model. Inside a transaction, the promise resolves right away and the change is applied when the transaction commits.

---

highlightGroup()

highlightGroup(groupId, nodes): Promise<void>

Highlights a group.

Parameters

groupId

string

The ID of the group to highlight.

nodes

Node[]

The nodes to highlight as part of the group.

Returns

Promise<void>

A promise that resolves once the change has been applied.

---

highlightGroupClear()

highlightGroupClear(): Promise<void>

Clears all group highlights.

Returns

Promise<void>

A promise that resolves once the change has been applied.

---

removeFromGroup()

removeFromGroup(groupId, nodeIds): Promise<void>

Removes nodes from a group.

Parameters

groupId

string

The ID of the group to remove nodes from.

nodeIds

string[]

Array of node IDs to remove from the group.

Returns

Promise<void>

A promise that resolves once the change has been applied to the model. Inside a transaction, the promise resolves right away and the change is applied when the transaction commits.