Class CanvasSnapshotPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

AViewerPluginSync<"">
- CanvasSnapshotPlugin
  - CanvasSnipperPlugin

Index

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

defaultOptions

defaultOptions: CanvasSnapshotOptions & { waitForProgressive?: boolean } = ...

Only for downloadSnapshot and functions using that

enabled

enabled: boolean = true

filename

filename: string = 'snapshot.png'

`Optional`uiConfig

uiConfig?: UiObjectConfig = 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:107
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected`_downloadJpeg

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

`Protected`_downloadPng

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

`Protected`_downloadWebp

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

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

downloadSnapshot

downloadSnapshot(
filename?: string,
options?: CanvasSnapshotOptions & { waitForProgressive?: boolean },
): Promise<void>
Parameters
- Optionalfilename: string
- options: CanvasSnapshotOptions & { waitForProgressive?: boolean } = ...
Returns Promise<void>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:93

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

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:41

getDataUrl

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

getFile

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional`setDirty

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

toJSON

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

Class CanvasSnapshotPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CanvasSnapshotPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

defaultOptions

enabled

filename

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_downloadJpeg

Returns Promise<void>

Protected_downloadPng

Returns Promise<void>

Protected_downloadWebp

Returns Promise<void>

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

downloadSnapshot

Parameters

Returns Promise<void>

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | CanvasSnapshotPlugin | Promise<null | CanvasSnapshotPlugin>

getDataUrl

Parameters

Returns Promise<string>

getFile

Parameters

Returns Promise<undefined | File>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_downloadJpeg

`Protected`_downloadPng

`Protected`_downloadWebp

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty