Skip to main content

Class: MultiFilterPlugin<TEvent, TPasses>

Plugins.MultiFilterPlugin

Type parameters

NameType
TEventextends string
TPassesextends IFilter<IPass, IPassID>[]

Hierarchy

Implements

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty


viewer

get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer


passes

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

Returns

TTupleRecord<TPasses, "passId">


pipeline

get pipeline(): string[]

Returns

string[]

set pipeline(value): void

Parameters

NameType
valuestring[]

Returns

void

Properties

enabled

Abstract enabled: boolean

Inherited from

AViewerPlugin.enabled


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

AViewerPlugin.onDispose


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

AViewerPlugin.storeState


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

AViewerPlugin.loadState


createPasses

Abstract createPasses(v): TPasses

Parameters

NameType
vViewerApp

Returns

TPasses


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

AViewerPlugin.onAdded


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

AViewerPlugin.onRemove


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Overrides

AViewerPlugin.toJSON


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | MultiFilterPlugin<TEvent, TPasses>

Implementation of

IViewerPluginAsync.fromJSON

Overrides

AViewerPlugin.fromJSON


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

new MultiFilterPlugin<TEvent, TPasses>()

Type parameters

NameType
TEventextends string
TPassesextends IFilter<IPass, string>[]

Overrides

AViewerPlugin.constructor