getNodePaths Method

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

getNodePaths(requestContext: ClientRequestContext, requestOptions: HierarchyRequestOptions<IModelDb>, paths: InstanceKey[][], markedIndex: number): Promise<NodePathElement[]>

Parameter Type Description
requestContext ClientRequestContext The client request context
requestOptions HierarchyRequestOptions<IModelDb> 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: 13 June, 2024