Interface TreeViewParams

Parameters to create a 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 | string[];
    pruneEmptyNodes?: boolean;
    rootName?: string;
    sortNodes?: boolean;
    view: View;
}

Hierarchy (View Summary)

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 model that determines the structure of the TreeView.

Optionalevents

events?: TreeViewEvents

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

OptionalexcludeViewLayerIds

excludeViewLayerIds?: string[]

groupTypes

groupTypes: string[]

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

The grouping for the 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

TODO

OptionalincludeViewLayerIds

includeViewLayerIds?: string[]

linkType

linkType: string | string[]

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

OptionalpruneEmptyNodes

pruneEmptyNodes?: boolean

OptionalrootName

rootName?: string

OptionalsortNodes

sortNodes?: boolean

view

view: View

The View that contains the ViewObjects navigated by the TreeView.

Settings

Member Visibility

On This Page

Properties