Skip to main content

Class: ExtrasUiPlugin

UI-Plugins.ExtrasUiPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "ExtrasUiPlugin1"

Defined in

webgi/src/plugins/ExtrasUiPlugin.ts:5


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/ExtrasUiPlugin.ts:7


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/ExtrasUiPlugin.ts:9


uiConfig

uiConfig: Object

Type declaration

NameType
typestring
labelstring
limitedUiboolean
children() => { label: string ; type: string = 'button'; value: () => Promise<void> }[]

Defined in

webgi/src/plugins/ExtrasUiPlugin.ts:11


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onAdded

Defined in

webgi/src/core/AViewerPlugin.ts:34


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:42


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | ExtrasUiPlugin | Promise<null | ExtrasUiPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

Constructors

constructor

new ExtrasUiPlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39