NodePathAPI

createNodePathHandles(targets)

createNodePathHandles Creates and returns handles for the target node ids or topology selectors.

Arguments

• targets (Array) – Array of target node ids or handles to create the handles for

Returns

Promise<Array<INodePathHandle>> – The array of handles

requestNodePathHandleMap(paths, scope)

requestNodePathHandleMap Returns an object mapping from input paths to the respective handles

Arguments

• paths (Array) – The array of node path strings or handles

• scope (number()) – [scope=0] Node id specifying the scope as starting point for the paths Optional

Returns

Promise<NodePathHandleMap> – The resulting object mapping paths to handles

requestNodePathStrings(handles, scope, typePriorities)

requestNodePathStrings Returns string representations for the respective node path handles.

Arguments

• handles – (Array<INodePathHandle> )

• scope (number()) – Optional

• typePriorities – (Array<NodePathFragmentType> ) Array of priorities to control the fragments for the path string assembly. Optional

Returns

Promise<Array<string>> – String representation of the node path for the respective scope.