Class: CanvasSnipperPlugin
Plugins.CanvasSnipperPlugin
Hierarchy
AViewerPlugin<"">↳
CanvasSnipperPlugin
Properties
PluginType
▪ Static Readonly PluginType: "CanvasSnipper"
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:11
enabled
• enabled: boolean = true
Overrides
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:12
filename
• filename: string = 'snapshot.png'
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:57
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get viewer(): undefined | TViewer
Returns
undefined | TViewer
Inherited from
AViewerPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:36
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:44
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:49
fromJSON
▸ fromJSON(data, meta?): null | CanvasSnipperPlugin | Promise<null | CanvasSnipperPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | CanvasSnipperPlugin | Promise<null | CanvasSnipperPlugin>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:56
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
getFile
▸ getFile(filename?, options?): Promise<undefined | File>
Parameters
| Name | Type |
|---|---|
filename? | string |
options | SnipOptions & { waitForProgressive?: boolean } |
Returns
Promise<undefined | File>
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:19
getDataUrl
▸ getDataUrl(options?): Promise<string>
Parameters
| Name | Type |
|---|---|
options | SnipOptions |
Returns
Promise<string>
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:24
downloadSnapshot
▸ downloadSnapshot(filename?, options?): Promise<void>
Parameters
| Name | Type |
|---|---|
filename? | string |
options | SnipOptions & { waitForProgressive?: boolean } |
Returns
Promise<void>
Defined in
webgi/src/plugins/CanvasSnipperPlugin.ts:60
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
Constructors
constructor
• new CanvasSnipperPlugin()