Class AViewerPluginSync<TE, TViewer>Abstract

Abstractenabled

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

dirty

• get dirty(): boolean

  Returns boolean

• set dirty(value: boolean): void

  Parameters

  • value: boolean

  Returns void

disable

• disable(key: any, setDirty?: boolean): void

  Parameters

  • key: any
  • setDirty: boolean = true

  Returns void

dispose

• dispose(): void

  Returns void

enable

• enable(key: any, setDirty?: boolean): void

  Parameters

  • key: any
  • setDirty: boolean = true

  Returns void

exportState

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

  Returns ISerializedConfig | Record<string, never>

fromJSON

• fromJSON(
      data: ISerializedConfig,
      meta?: SerializationMetaType,
  ):
      | null
      | AViewerPluginSync<TE, TViewer>
      | Promise<null | AViewerPluginSync<TE, TViewer>>

  Parameters

  • data: ISerializedConfig
  • Optionalmeta: SerializationMetaType

  Returns
      | null
      | AViewerPluginSync<TE, TViewer>
      | Promise<null | AViewerPluginSync<TE, TViewer>>

importState

• importState(state: any): Promise<void>

  Parameters

  • state: any

  Returns Promise<void>

isDisabled

• isDisabled(): boolean

  Returns boolean

OptionalsetDirty

• setDirty(...args: any[]): any

  Parameters

  • ...args: any[]

  Returns any

toJSON

• toJSON(meta?: SerializationMetaType): ISerializedConfig

  Parameters

  • Optionalmeta: SerializationMetaType

  Returns ISerializedConfig