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

AViewerPlugin.enabled

Defined in

webgi/src/plugins/FileTransferPlugin.ts:5

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

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

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Constructors

constructor

• new FileTransferPlugin()

Inherited from

AViewerPlugin.constructor

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

Methods

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onAdded

Defined in

webgi/src/core/AViewerPlugin.ts:32

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | FileTransferPlugin | Promise<null | FileTransferPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

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

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60