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

Hierarchy

Index

Properties

dependency: string[]

List of IDs of parameters influencing this export.

hidden: boolean

Controls whether the parameter should be hidden in the UI.

id: string

ID of the export, dependent on model ID, and therefore changing each time a model gets uploaded.

name: string

Name of the export.

Type of export.

Result parts. In case this array does not exist, this means that the workers have not finished computation for this output version.

delay?: number

The delay in milliseconds after which an export cache request shall be sent to check again for this export version. This property is used ONLY if the export version has not been computed yet.

Note that the existence of this property does not necessarily imply the presence of an active or queued computation for the respective export version.

displayname?: string

Parameter name to display instead of name.

filename?: string

Optional suggested filename for the files to be downloaded.

group?: ShapeDiverCommonsGroup

Group of an export.

msg?: string

In case computation of the export version (temporarily) failed:
Optional message to the user, explaining what went wrong.

order?: number

Ordering of the export in client applications.

Optional result object for exports of type email and shapeways.

Status of collecting results for the export version.

Status of the computation which resulted in the export version.

tooltip?: string

Description that is shown as a tooltip in the clients.

uid?: string

Constant ID of the export, not dependent on model ID, and therefore NOT changing each time a model gets uploaded. Might be undefined because this property was introduced in summer 2020 and does not exist for exports of older models.

version?: string

Requested version of the export.

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]: string

    Returns Promise<ShapeDiverResponseExport>