getNodePaths Method

Retrieves paths from root nodes to children nodes according to specified keys. Intersecting paths will be merged.

getNodePaths(requestOptions: ExtendedHierarchyRequestOptions<IModelConnection, never, RulesetVariable>, paths: InstanceKey[][], markedIndex: number): Promise<NodePathElement[]>

Parameter Type Description
requestOptions ExtendedHierarchyRequestOptions<IModelConnection, never, RulesetVariable> options for the request
paths InstanceKey[][] Paths from root node to some child node.
markedIndex number Index of the path in paths that will be marked.

Returns - Promise<NodePathElement[]>

A promise object that returns either an array of paths on success or an error string on error.

Defined in

Last Updated: 12 June, 2024