getNodePaths Method

Overloads
getNodePaths(requestOptions)  
getNodePaths(requestContext, requestOptions, paths, markedIndex) Deprecated  

getNodePaths(requestOptions)

Retrieves paths from root nodes to children nodes according to specified instance key paths. Intersecting paths will be merged. TODO: Return results in pages

getNodePaths(requestOptions: WithClientRequestContext<HierarchyRequestOptions<IModelDb, RulesetVariable> & { markedIndex: number, paths: InstanceKey[][] }>): Promise<NodePathElement[]>

Parameter Type Description
requestOptions WithClientRequestContext<HierarchyRequestOptions<IModelDb, RulesetVariable> & { markedIndex: number, paths: InstanceKey[][] }>  

Returns - Promise<NodePathElement[]>



getNodePaths(requestContext, requestOptions, paths, markedIndex)

Deprecated  Use an overload with one argument

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

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

Parameter Type Description
requestContext ClientRequestContext  
requestOptions HierarchyRequestOptions<IModelDb, RulesetVariable>  
paths InstanceKey[][]  
markedIndex number  

Returns - Promise<NodePathElement[]>


Defined in

Last Updated: 11 June, 2024