Class FileTransferPlugin

File Transfer Plugin

Provides a way to extend the viewer.export functionality with custom actions. Used in AWSClientPlugin to upload files directly to S3.

Hierarchy (view full)

AViewerPluginSync<"transferFile">
- FileTransferPlugin

Index

Constructors

constructor

new FileTransferPlugin(): FileTransferPlugin
Returns FileTransferPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/export/FileTransferPlugin.ts:34

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

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

actions

actions: {
exportFile: ((blob, name, _onProgress?) => Promise<void>);
} = ...

Type declaration

exportFile: ((blob, name, _onProgress?) => Promise<void>)
- - (blob, name, _onProgress?): Promise<void>
  - Parameters
    - blob: Blob
    - name: string
    - Optional _onProgress: ((d) => void)
      (d): void
      Parameters
      d: {
      progress?: number;
      state?: string;
      }
      Optional progress?: number
      Optional state?: string
      Returns void
    Returns Promise<void>

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Readonly` defaultActions

defaultActions: {
exportFile: ((blob, name, _onProgress?) => Promise<void>);
} = ...

Type declaration

exportFile: ((blob, name, _onProgress?) => Promise<void>)
- - (blob, name, _onProgress?): Promise<void>
  - Parameters
    - blob: Blob
    - name: string
    - Optional _onProgress: ((d) => void)
      (d): void
      Parameters
      d: {
      progress?: number;
      state?: string;
      }
      Optional progress?: number
      Optional state?: string
      Returns void
    Returns Promise<void>

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

`Optional` uiConfig

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

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "FileTransferPlugin" = 'FileTransferPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

`Protected` _updateProcessState

_updateProcessState(data): void
Parameters
- data: {
      path: string;
      progress?: number;
      state: string;
  }
  - path: string
  - Optional progress?: number
  - state: string
Returns void
- Defined in src/plugins/export/FileTransferPlugin.ts:48

disable

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

dispose

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

enable

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

exportFile

exportFile(file, name?): Promise<void>
Parameters
- file: Blob | File
- Optional name: string
Returns Promise<void>
- Defined in src/plugins/export/FileTransferPlugin.ts:18

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/export/FileTransferPlugin.ts:39

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/export/FileTransferPlugin.ts:43

`Optional` setDirty

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

Class FileTransferPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FileTransferPlugin

Properties

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

actions

Type declaration

exportFile: ((blob, name, _onProgress?) => Promise<void>)

Parameters

blob: Blob

name: string

Optional _onProgress: ((d) => void)

Parameters

d: { progress?: number; state?: string; }

Optional progress?: number

Optional state?: string

Returns void

Returns Promise<void>

constructor

Readonly defaultActions

Type declaration

exportFile: ((blob, name, _onProgress?) => Promise<void>)

Parameters

blob: Blob

name: string

Optional _onProgress: ((d) => void)

Parameters

d: { progress?: number; state?: string; }

Optional progress?: number

Optional state?: string

Returns void

Returns Promise<void>

enabled

toJSON

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

Protected _updateProcessState

Parameters

data: { path: string; progress?: number; state: string; }

path: string

Optional progress?: number

state: string

Returns void

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` _onProgress: ((d) => void)

d: {
progress?: number;
state?: string;
}

`Optional` progress?: number

`Optional` state?: string

`Readonly` defaultActions

`Optional` _onProgress: ((d) => void)

d: {
progress?: number;
state?: string;
}

`Optional` progress?: number

`Optional` state?: string

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Protected` _updateProcessState

data: {
path: string;
progress?: number;
state: string;
}

`Optional` progress?: number

`Optional` name: string

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]