ThreePipe
    Preparing search index...

    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)

    Index

    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

    Properties

    Protected_dirty

    _dirty: boolean = false

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    actions: {
        exportFile: (
            blob: Blob,
            name: string,
            _onProgress?: (
                d: { progress?: number; state?: "error" | "done" | "exporting" },
            ) => void,
        ) => Promise<void>;
    } = ...
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    defaultActions: {
        exportFile: (
            blob: Blob,
            name: string,
            _onProgress?: (
                d: { progress?: number; state?: "error" | "done" | "exporting" },
            ) => void,
        ) => Promise<void>;
    } = ...
    enabled: boolean = true
    toJSON: any = undefined
    uiConfig?: UiObjectConfig<any, string, any> = undefined
    OldPluginType?: string
    PluginType: "FileTransferPlugin" = 'FileTransferPlugin'

    Accessors

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods