Interface: IViewerPlugin<IsSync>

Core-API.IViewerPlugin

Type parameters

Name	Type
IsSync	extends boolean = boolean

Hierarchy

• IEventDispatcher<string>

• IUiConfigContainer

• Partial<IJSONSerializable>

  ↳ IViewerPlugin

  ↳↳ IViewerPluginSync

  ↳↳ IViewerPluginAsync

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

Name	Type
viewer	ViewerApp

Returns

IsSync extends false ? Promise<void> : void

---

onRemove

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

Parameters

Name	Type
viewer	ViewerApp

Returns

IsSync extends false ? Promise<void> : void

---

onDispose

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

Parameters

Name	Type
viewer	ViewerApp

Returns

IsSync extends false ? Promise<void> : void

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>