Skip to main content

Class: HierarchyUiPlugin

UI-Plugins.HierarchyUiPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "HierarchyUiPlugin"

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:10


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:9


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:12


treeView

treeView: any = undefined

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:14


hierarchyDiv

hierarchyDiv: HTMLDivElement

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:16


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:103

Methods

fromJSON

fromJSON(data, meta?): null | HierarchyUiPlugin | Promise<null | HierarchyUiPlugin>

Parameters

NameType
dataany
meta?any

Returns

null | HierarchyUiPlugin | Promise<null | HierarchyUiPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


reset

reset(e?): undefined | Promise<void>

Parameters

NameType
e?any

Returns

undefined | Promise<void>

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:41


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:81


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:87


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onDispose

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:93


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

new HierarchyUiPlugin(enabled?)

Parameters

NameTypeDefault value
enabledbooleantrue

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/HierarchyUiPlugin.ts:22