Class: CanvasSnipperPlugin

Plugins.CanvasSnipperPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ CanvasSnipperPlugin

Properties

PluginType

▪ Static Readonly PluginType: "CanvasSnipper"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

filename

• filename: string = 'snapshot'

---

progressiveFrames

• progressiveFrames: number = 64

---

tileRows

• tileRows: number = 1

---

tileColumns

• tileColumns: number = 1

---

rect

• rect: Vector4

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onAdded

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | CanvasSnipperPlugin | Promise<null | CanvasSnipperPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | CanvasSnipperPlugin | Promise<null | CanvasSnipperPlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

getFile

▸ getFile(filename?, options?): Promise<undefined | File>

Parameters

Name	Type
filename?	string
options	CanvasSnipperOptions

Returns

Promise<undefined | File>

---

getDataUrl

▸ getDataUrl(options?): Promise<string>

Parameters

Name	Type
options	SnipOptions

Returns

Promise<string>

---

downloadSnapshot

▸ downloadSnapshot(filename?, options?): Promise<void>

Parameters

Name	Type
filename?	string
options?	CanvasSnipperOptions

Returns

Promise<void>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_downloadJpeg

▸ Protected _downloadJpeg(): Promise<void>

Returns

Promise<void>

---

_downloadWebp

▸ Protected _downloadWebp(): Promise<void>

Returns

Promise<void>

Constructors

constructor

• new CanvasSnipperPlugin()

Overrides

AViewerPlugin.constructor