Interface TreeViewParams

Parameters to create a treeview!TreeView | TreeView.

See @xeokit/sdk/treeview for usage.

interface TreeViewParams {
    autoExpandDepth?: number;
    containerElement: HTMLElement;
    data: Data;
    events?: TreeViewEvents;
    excludeViewLayerIds?: string[];
    groupTypes: string[];
    hierarchy: number;
    includeViewLayerIds?: string[];
    linkType: string;
    pruneEmptyNodes?: boolean;
    rootName?: string;
    sortNodes?: boolean;
    view: View;
}

Properties

autoExpandDepth? containerElement data events? excludeViewLayerIds? groupTypes hierarchy includeViewLayerIds? linkType pruneEmptyNodes? rootName? sortNodes? view

Properties

OptionalautoExpandDepth

autoExpandDepth?: number

containerElement

containerElement: HTMLElement

data

data: Data

The semantic !Data | Data model that determines the structure of the treeview!TreeView | TreeView.

Optionalevents

events?: TreeViewEvents

External emitters for this treeview!TreeView | TreeView. Used when routing events from multiple TreeViews.

OptionalexcludeViewLayerIds

excludeViewLayerIds?: string[]

groupTypes

groupTypes: string[]

When traversing the !Data | Data to build the tree UI nodes for a treeview!TreeView.GroupsHierarchy | GroupsHierarchy hierarchy, these are the values of !DataObject.type | DataObject.type that the treeview!TreeView | TreeView groups the !DataObject | DataObjects on.

The grouping for the treeview!TreeView.GroupsHierarchy | GroupsHierarchy hierarchy has two levels. The major grouping type is given in groupTypes[0] and the minor grouping type is given in storeyGroups[1].

hierarchy

hierarchy: number

!DataObject.type | DataObject.type

TODO

OptionalincludeViewLayerIds

includeViewLayerIds?: string[]

linkType

linkType: string

When traversing the !Data | Data to build the tree UI nodes, at each !DataObject | DataObjects, the treeview!TreeView | TreeView will traverse only the outgoing !Relationship| Relationships of this type in !DataObject.relating | DataObject.relating.

OptionalpruneEmptyNodes

pruneEmptyNodes?: boolean

OptionalrootName

rootName?: string

OptionalsortNodes

sortNodes?: boolean

view

view: View

The View that contains the ViewObjects navigated by the treeview!TreeView | TreeView.

Settings

Member Visibility

On This Page

Properties