Class CanvasSnapshotPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

AViewerPluginSync
- CanvasSnapshotPlugin
  - CanvasSnipperPlugin

Constructors

constructor

new CanvasSnapshotPlugin(): CanvasSnapshotPlugin
Returns CanvasSnapshotPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:40

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

defaultOptions

defaultOptions: CanvasSnapshotPluginOptions = ...

Only for downloadSnapshot and functions using that

enabled

enabled: boolean = true

filename

filename: string = 'snapshot'

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "CanvasSnapshotPlugin" = 'CanvasSnapshotPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_downloadJpeg

_downloadJpeg(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:218

`Protected`_downloadPng

_downloadPng(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:213

`Protected`_downloadWebp

_downloadWebp(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:223

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

downloadSnapshot

downloadSnapshot(
filename?: string,
options?: CanvasSnapshotPluginOptions,
): Promise<void>
Parameters
- Optionalfilename: string
- options: CanvasSnapshotPluginOptions = ...
Returns Promise<void>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:195

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | CanvasSnapshotPlugin | Promise<null | CanvasSnapshotPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | CanvasSnapshotPlugin | Promise<null | CanvasSnapshotPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

getDataUrl

getDataUrl(options?: CanvasSnapshotPluginOptions): Promise<string>
Returns a data url of the screenshot of the viewer canvas
Parameters
- options: CanvasSnapshotPluginOptions = {}
  waitForProgressive: wait for progressive rendering to finish, default: true
Returns Promise<string>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:58

getFile

getFile(
filename?: string,
options?: CanvasSnapshotPluginOptions,
): Promise<undefined | File>
Returns a File object with screenshot of the viewer canvas
Parameters
- Optionalfilename: string
  default is CanvasSnapshotPlugin.filename
- options: CanvasSnapshotPluginOptions = ...
  waitForProgressive: wait for progressive rendering to finish, default: true
Returns Promise<undefined | File>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:50

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onAdded
- Defined in src/viewer/AViewerPlugin.ts:148

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:152

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39