Class: FileTransferPlugin
Plugins.FileTransferPlugin
Hierarchy
AViewerPlugin<"transferFile">↳
FileTransferPlugin
Properties
PluginType
▪ Static Readonly PluginType: "FileTransferPlugin"
Defined in
webgi/src/plugins/FileTransferPlugin.ts:7
enabled
• enabled: boolean = true
Overrides
Defined in
webgi/src/plugins/FileTransferPlugin.ts:5
toJSON
• toJSON: any = undefined
Overrides
Defined in
webgi/src/plugins/FileTransferPlugin.ts:9
defaultActions
• Readonly defaultActions: Object
Type declaration
| Name | Type |
|---|---|
exportFile | (blob: Blob, name: string, onProgress?: (d: { state?: string ; progress?: number }) => void) => Promise<void> |
Defined in
webgi/src/plugins/FileTransferPlugin.ts:20
actions
• actions: Object
Type declaration
| Name | Type |
|---|---|
exportFile | (blob: Blob, name: string, onProgress?: (d: { state?: string ; progress?: number }) => void) => Promise<void> |
Defined in
webgi/src/plugins/FileTransferPlugin.ts:26
_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
Constructors
constructor
• new FileTransferPlugin()
Inherited from
Defined in
webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41
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
fromJSON
▸ fromJSON(data, meta?): null | FileTransferPlugin | Promise<null | FileTransferPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | FileTransferPlugin | Promise<null | FileTransferPlugin>
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
exportFile
▸ exportFile(file, name?): Promise<void>
Parameters
| Name | Type |
|---|---|
file | File | Blob |
name? | string |
Returns
Promise<void>
Defined in
webgi/src/plugins/FileTransferPlugin.ts:11
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string