Class AViewerPlugin<T, TViewer, IsSync>Abstract

constructor

Abstract enabled

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

dirty

• get dirty(): boolean

• Returns boolean

• set dirty(value): void

• Parameters

  • value: boolean

  Returns void

disable

• disable(key): void

• Parameters

  • key: any

  Returns void

dispose

• dispose(): void

• Returns void

enable

• enable(key): void

• Parameters

  • key: any

  Returns void

exportState

• exportState(): ISerializedConfig | Record<string, never>

• Returns ISerializedConfig | Record<string, never>

fromJSON

• fromJSON(data, meta?): null | AViewerPlugin<T, TViewer, IsSync> | Promise<null | AViewerPlugin<T, TViewer, IsSync>>

• Parameters

  • data: ISerializedConfig

  • Optional meta: SerializationMetaType

  Returns null | AViewerPlugin<T, TViewer, IsSync> | Promise<null | AViewerPlugin<T, TViewer, IsSync>>

importState

• importState(state): Promise<void>

• Parameters

  • state: any

  Returns Promise<void>

isDisabled

• isDisabled(): boolean

• Returns boolean

Abstract onAdded

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

• Parameters

  • viewer: TViewer

  Returns IsSync extends false
      ? Promise<void>
      : void

Abstract onRemove

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

• Parameters

  • viewer: TViewer

  Returns IsSync extends false
      ? Promise<void>
      : void

Optional setDirty

• setDirty(...args): any

• Parameters

  • Rest ...args: any[]

  Returns any

toJSON

• toJSON(meta?): ISerializedConfig

• Parameters

  • Optional meta: SerializationMetaType

  Returns ISerializedConfig