The NgDiagramModelService provides methods for accessing and manipulating the diagram’s model,

Example usage

private modelService = inject(NgDiagramModelService);

// Add nodes
this.modelService.addNodes([node1, node2]);

Extends

• NgDiagramBaseService

Implements

• OnDestroy

Properties

edges

readonly edges: Signal<Edge<object>[]>

Readonly signal of current edges in the diagram.

---

metadata

readonly metadata: Signal<Metadata<object>>

Readonly signal of current diagram metadata.

---

nodes

readonly nodes: Signal<Node[]>

Readonly signal of current nodes in the diagram.

Methods

addEdges()

addEdges(edges): void

Adds new edges to the diagram.

Parameters

edges

Edge<object>[]

Array of edges to add.

Returns

void

---

addNodes()

addNodes(nodes): void

Adds new nodes to the diagram.

Parameters

nodes

Node[]

Array of nodes to add.

Returns

void

---

deleteEdges()

deleteEdges(ids): void

Deletes edges by their IDs.

Parameters

ids

string[]

Array of edge IDs to delete.

Returns

void

---

deleteNodes()

deleteNodes(ids): void

Deletes nodes by their IDs.

Parameters

ids

string[]

Array of node IDs to delete.

Returns

void

---

getChildren()

getChildren(groupId): Node[]

Gets all children nodes for a given group node id

Parameters

groupId

string

group node id

Returns

Node[]

Array of child nodes

---

getChildrenNested()

getChildrenNested(groupId): Node[]

Gets all nested children (descendants) of a group node

Parameters

groupId

string

Group node id

Returns

Node[]

Array of all descendant nodes (children, grandchildren, etc.)

---

getConnectedEdges()

getConnectedEdges(nodeId): Edge<object>[]

Gets all edges connected to a node

Parameters

nodeId

string

Node id

Returns

Edge<object>[]

Array of edges where the node is either source or target

---

getConnectedNodes()

getConnectedNodes(nodeId): Node[]

Gets all nodes connected to a node via edges

Parameters

nodeId

string

Node id

Returns

Node[]

Array of nodes connected to the given node

---

getEdgeById()

getEdgeById(edgeId): null | Edge<object>

Gets an edge by id.

Parameters

edgeId

string

Edge id.

Returns

null | Edge<object>

Edge or null if not found.

---

getModel()

getModel(): ModelAdapter

Returns the current model that NgDiagram instance is using. Returns null if flowCore is not initialized.

Returns

ModelAdapter

---

getNearestNodeInRange()

getNearestNodeInRange(point, range): null | Node

Gets the nearest node in a range from a point.

Parameters

point

Point

Point to check from.

range

number

Range to check in.

Returns

null | Node

Nearest node in range or null.

---

getNearestPortInRange()

getNearestPortInRange(point, range): null | Port

Gets the nearest port in a range from a point.

Parameters

point

Point

Point to check from.

range

number

Range to check in.

Returns

null | Port

Nearest port in range or null.

---

getNodeById()

getNodeById(nodeId): null | Node

Gets a node by id.

Parameters

nodeId

string

Node id.

Returns

null | Node

Node or null if not found.

---

getNodeEnds()

getNodeEnds(edgeId): null | { source: Node; target: Node; }

Gets the source and target nodes of an edge

Parameters

edgeId

string

Edge id

Returns

null | { source: Node; target: Node; }

Object containing source and target nodes, or null if edge doesn’t exist

---

getNodesInRange()

getNodesInRange(point, range): Node[]

Gets all nodes in a range from a point.

Parameters

point

Point

Point to check from.

range

number

Range to check in.

Returns

Node[]

Array of nodes in range.

---

getOverlappingNodes()

getOverlappingNodes(nodeId): Node[]

Detects collision with other nodes by finding all nodes whose rectangles intersect with the specified node’s bounding rectangle.

Parameters

nodeId

string

The ID of the node to check for collisions

Returns

Node[]

An array of Nodes that overlap with the specified node

---

getParentHierarchy()

getParentHierarchy(nodeId): GroupNode<object>[]

Gets the full chain of parent group Nodes for a given nodeId.

Parameters

nodeId

string

Node id

Returns

GroupNode<object>[]

Array of parent group Node objects, from closest parent to farthest ancestor

---

isNestedChild()

isNestedChild(nodeId, groupId): boolean

Checks if a node is a nested child (descendant) of a group node

Parameters

nodeId

string

Node id

groupId

string

Group node id

Returns

boolean

True if the node is part of the group’s nested subgraph

---

toJSON()

toJSON(): string

Serializes the current model to a JSON string.

Returns

string

The model as a JSON string.

---

updateEdge()

updateEdge(edgeId, edge): void

Updates the properties of an edge.

Parameters

edgeId

string

Edge id.

edge

Partial<Edge>

New edge properties.

Returns

void

---

updateEdgeData()

updateEdgeData<T>(edgeId, data): void

Updates the data of an edge.

Type Parameters

T

T extends undefined | Record<string, unknown>

Parameters

edgeId

string

Edge id.

data

T

New data to set for the edge (can be strongly typed).

Returns

void

---

updateEdges()

updateEdges(edges): void

Updates multiple edges at once.

Parameters

edges

Pick<Edge<object>, "id"> & Partial<Edge<object>>[]

Array of edge updates (must include id and any properties to update).

Returns

void

---

updateNode()

updateNode(nodeId, node): void

Updates the properties of a node.

Parameters

nodeId

string

Node id.

node

Partial<Node>

New node properties.

Returns

void

---

updateNodeData()

updateNodeData<T>(nodeId, data): void

Updates the data of a node.

Type Parameters

T

T extends undefined | Record<string, unknown>

Parameters

nodeId

string

Node id.

data

T

New data to set for the node (can be strongly typed).

Returns

void

---

updateNodes()

updateNodes(nodes): void

Updates multiple nodes at once.

Parameters

nodes

Pick<Node, "id"> & Partial<Node>[]

Array of node updates (must include id and any properties to update).

Returns

void