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 Summary)

Constructors

constructor

Properties

_dirty _viewer? _viewerListeners actions constructor defaultActions enabled toJSON uiConfig? OldPluginType? PluginType

Accessors

dirty

Methods

_onViewerEvent _storeKey _updateProcessState disable dispose enable exportFile exportState fromJSON importState isDisabled onAdded onRemove setDirty?

Constructors

constructor

Properties

Protected_dirty

_dirty: boolean = false

Protected Optional_viewer

_viewer?: ThreeViewer

Protected_viewerListeners

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

actions

actions: {
    exportFile: (
        blob: Blob,
        name: string,
        _onProgress?: (d: { progress?: number; state?: string }) => void,
    ) => Promise<void>;
} = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

ReadonlydefaultActions

defaultActions: {
    exportFile: (
        blob: Blob,
        name: string,
        _onProgress?: (d: { progress?: number; state?: string }) => void,
    ) => Promise<void>;
} = ...

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

OptionaluiConfig

uiConfig?: UiObjectConfig = undefined

Static Optional ReadonlyOldPluginType

OldPluginType?: string

Static ReadonlyPluginType

PluginType: "FileTransferPlugin" = 'FileTransferPlugin'

Accessors

dirty

Methods

Protected_onViewerEvent

Protected_storeKey

Protected_updateProcessState

  • _updateProcessState(
        data: { path: string; progress?: number; state: string },
    ): void

  • Parameters

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

    Returns void

disable

dispose

enable

exportFile

exportState

fromJSON

importState

isDisabled

onAdded

onRemove

OptionalsetDirty

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods