Interface List3DNodesQuery

Cursor for paging through results

interface List3DNodesQuery {
    cursor?: string;
    depth?: number;
    limit?: number;
    nodeId?: number;
    partition?: string;
    properties?: Node3DProperties;
    sortByNodeId?: boolean;
}

Hierarchy (view full)

Properties

cursor? depth? limit? nodeId? partition? properties? sortByNodeId?

Properties

Optionalcursor

cursor?: string

Optionaldepth

depth?: number

Get sub nodes up to this many levels below the specified node. Depth 0 is the root node.

Optionallimit

limit?: number

OptionalnodeId

nodeId?: number

ID of a node that are the root of the subtree you request (default is the root node).

Optionalpartition

partition?: string

Partition specifier of the form "n/m". It will return the n'th (1-indexed) part of the result divided into m parts

Optionalproperties

properties?: Node3DProperties

Filter for node properties. Only nodes that match all the given properties exactly will be listed. The filter must be a JSON object with the same format as the properties field.

OptionalsortByNodeId

sortByNodeId?: boolean

Enables sorting on node ID as opposed to tree index. This may result in faster response times for certain requests.

Settings

Member Visibility

On This Page

Properties