Viewer
    Preparing search index...

    Interface IExportApi

    The api for an export of a corresponding [session]ISessionApi.

    Exports are used for outputting data which should not be visualized in the scene, or which should not be accessible via the viewport.

    Exports are NOT computed as part of customizations (see customize). The export can be requested by calling its request method.

    Only the properties of ResExportDefinition will stay constant over the lifetime of a session. All additional properties that are added via the extension to ResExport can change according to the last export request.

    interface IExportApi {
        dependency: string[];
        hidden: boolean;
        id: string;
        name: string;
        type: EXPORT_TYPE;
        version: string;
        request(
            parameters?: { [key: string]: unknown },
        ): Promise<ShapeDiverResponseExport>;
        content?: ShapeDiverResponseExportContent[];
        delay?: number;
        displayname?: string;
        filename?: string;
        group?: CommonsGroup;
        msg?: string;
        order?: number;
        result?: ShapeDiverResponseExportResult;
        status_collect?: ResComputationStatus;
        status_computation?: ResComputationStatus;
        tooltip?: string;
        typeId?: string;
        typeName?: string;
        uid?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dependency hidden id name type version content? delay? displayname? filename? group? msg? order? result? status_collect? status_computation? tooltip? typeId? typeName? uid?

    Methods

    request

    Properties

    dependency: string[]
    hidden: boolean
    id: string
    name: string
    type: EXPORT_TYPE
    version: string

    Optionalcontent

    content?: ShapeDiverResponseExportContent[]
    delay?: number
    displayname?: string
    filename?: string
    group?: CommonsGroup
    msg?: string
    order?: number
    result?: ShapeDiverResponseExportResult
    status_collect?: ResComputationStatus
    status_computation?: ResComputationStatus
    tooltip?: string
    typeId?: string
    typeName?: string
    uid?: string

    Methods

    • Request the export.

      Parameters

      • Optionalparameters: { [key: string]: unknown }

        Parameter values to be used for this export request. Map from parameter id to parameter value. The current value will be used for any parameter not specified.

      Returns Promise<ShapeDiverResponseExport>

      {@type ShapeDiverViewerError}

    Settings

    Member Visibility

    On This Page

    Properties
    Methods