Skip to main content

Class: MultiFilterPlugin<TEvent, TPasses, TViewer>

Plugins.MultiFilterPlugin

Type parameters

NameType
TEventextends string
TPassesextends IFilter<IPass, IPassID>[]
TViewerextends IViewerApp = ViewerApp

Hierarchy

Implements

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


viewer

get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

AViewerPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


passes

get passes(): TTupleRecord<TPasses, "passId">

Returns

TTupleRecord<TPasses, "passId">

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:17


pipeline

get pipeline(): string[]

Returns

string[]

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:22

set pipeline(value): void

Parameters

NameType
valuestring[]

Returns

void

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:26

Properties

enabled

Abstract enabled: boolean

Inherited from

AViewerPlugin.enabled

Defined in

webgi/src/core/AViewerPlugin.ts:34


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: TViewer

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88


createPasses

Abstract createPasses(v): TPasses

Parameters

NameType
vTViewer

Returns

TPasses

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:32


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:40


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:53


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:65


fromJSON

fromJSON(data, meta?): null | MultiFilterPlugin<TEvent, TPasses, TViewer>

Parameters

NameType
dataany
meta?any

Returns

null | MultiFilterPlugin<TEvent, TPasses, TViewer>

Implementation of

IViewerPlugin.fromJSON

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:77


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64

Constructors

constructor

new MultiFilterPlugin<TEvent, TPasses, TViewer>()

Type parameters

NameType
TEventextends string
TPassesextends IFilter<IPass, string>[]
TViewerextends IViewerApp<TViewer> = ViewerApp

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:36