Class CanvasSnapshotPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

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<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

defaultOptions

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

Only for downloadSnapshot and functions using that

Type declaration

Optional waitForProgressive?: boolean

enabled

enabled: boolean = true

filename

filename: string = 'snapshot.png'

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "CanvasSnapshotPlugin" = 'CanvasSnapshotPlugin'

Accessors

dirty

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

Methods

`Protected` _downloadJpeg

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

`Protected` _downloadWebp

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

`Private` _getFile

_getFile(filename, options?): Promise<undefined | string | File>
Parameters
- filename: string
- options: CanvasSnapshotOptions & {
  waitForProgressive?: boolean;
  } = {}
Returns Promise<undefined | string | File>
- Defined in src/plugins/export/CanvasSnapshotPlugin.ts:37

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

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

dispose

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

downloadSnapshot

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

enable

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

exportState

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

fromJSON

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

getDataUrl

getDataUrl(options?): 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:32

getFile

getFile(filename?, options?): Promise<undefined | File>
Returns a File object with screenshot of the viewer canvas
Parameters
- Optional filename: 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:23

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional` setDirty

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

toJSON

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

Class CanvasSnapshotPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CanvasSnapshotPlugin

Properties

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

defaultOptions

Type declaration

Optional waitForProgressive?: boolean

enabled

filename

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _downloadJpeg

Returns Promise<void>

Protected _downloadWebp

Returns Promise<void>

Private _getFile

Parameters

filename: string

options: CanvasSnapshotOptions & { waitForProgressive?: boolean; } = {}

Returns Promise<undefined | string | File>

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

downloadSnapshot

Parameters

Optional filename: string

options: CanvasSnapshotOptions & { waitForProgressive?: boolean; } = ...

Returns Promise<void>

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | CanvasSnapshotPlugin | Promise<null | CanvasSnapshotPlugin>

getDataUrl

Parameters

options: CanvasSnapshotOptions & { waitForProgressive?: boolean; } = {}

Returns Promise<string>

getFile

Parameters

Optional filename: string

options: CanvasSnapshotOptions & { waitForProgressive?: boolean; } = ...

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` waitForProgressive?: boolean

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _downloadJpeg

`Protected` _downloadWebp

`Private` _getFile

options: CanvasSnapshotOptions & {
waitForProgressive?: boolean;
} = {}

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` filename: string

options: CanvasSnapshotOptions & {
waitForProgressive?: boolean;
} = ...

`Optional` meta: SerializationMetaType

options: CanvasSnapshotOptions & {
waitForProgressive?: boolean;
} = {}

`Optional` filename: string

options: CanvasSnapshotOptions & {
waitForProgressive?: boolean;
} = ...

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType