Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IExportApi

The api for an export of a corresponding session.

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 {@link ResExportDefinition} will stay constant over the lifetime of a session. All additional properties that are added via the extension to {@link ResExport} can change according to the last export request.

Hierarchy

Index

Properties

dependency: string[]
hidden: boolean
id: string
name: string
version: string
delay?: number
displayname?: string
filename?: string
msg?: string
order?: number
status_collect?: ResComputationStatus
status_computation?: ResComputationStatus
tooltip?: string
uid?: string

Methods

  • Request the export.

    throws

    {@type ShapeDiverViewerError}

    Parameters

    • Optional parameters: {}

      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.

      • [key: string]: unknown

    Returns Promise<ShapeDiverResponseExport>