Skip to main content

Interface: IViewerPlugin<IsSync>

Core-API.IViewerPlugin

Type parameters

NameType
IsSyncextends boolean = boolean

Hierarchy

Properties

dependencies

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


dirty

Optional dirty: boolean


serializeWithViewer

Optional serializeWithViewer: boolean


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Methods

onAdded

onAdded(viewer): IsSync extends false ? Promise<void> : void

Parameters

NameType
viewerViewerApp

Returns

IsSync extends false ? Promise<void> : void


onRemove

onRemove(viewer): IsSync extends false ? Promise<void> : void

Parameters

NameType
viewerViewerApp

Returns

IsSync extends false ? Promise<void> : void


onDispose

Optional onDispose(viewer): IsSync extends false ? Promise<void> : void

Parameters

NameType
viewerViewerApp

Returns

IsSync extends false ? Promise<void> : void


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>