Skip to main content

Interface: IViewerPlugin<TViewer>

Core-API.IViewerPlugin

Type parameters

NameType
TViewerextends IViewerApp = IViewerApp

Hierarchy

Implemented by

Methods

addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameTypeDescription
typestringThe type of event to listen to.
listener(event: IEvent<string>) => voidThe function that gets called when the event is fired.

Returns

void

Inherited from

IEventDispatcher.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:14


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameTypeDescription
typestringThe type of event to listen to.
listener(event: IEvent<string>) => voidThe function that gets called when the event is fired.

Returns

boolean

Inherited from

IEventDispatcher.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:21


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameTypeDescription
typestringThe type of the listener that gets removed.
listener(event: IEvent<string>) => voidThe listener function that gets removed.

Returns

void

Inherited from

IEventDispatcher.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:28


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<string>

Returns

void

Inherited from

IEventDispatcher.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:34


toJSON

Optional toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

Partial.toJSON

Defined in

webgi/src/interfaces.ts:443


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | IJSONSerializable | Promise<null | IJSONSerializable>

Inherited from

Partial.fromJSON

Defined in

webgi/src/interfaces.ts:444


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:495


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:498


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:501

Properties

dependencies

Optional dependencies: Class<IViewerPlugin<any>>[]

Defined in

webgi/src/interfaces.ts:489


dirty

Optional dirty: boolean

Defined in

webgi/src/interfaces.ts:492


serializeWithViewer

Optional serializeWithViewer: boolean

Defined in

webgi/src/interfaces.ts:503


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Defined in

webgi/src/interfaces.ts:551