Type Alias ModelExportOptions

ModelExportOptions: {
    coordinateSystem?: CoordinateSystemParams;
    onProgress?: (progress: LoaderProgress) => void;
    signal?: AbortSignal;
    yieldIntervalMs?: number;
} & Record<string, any>

Options for customizing the export process when exporting a SceneModel and/or a DataModel to a file.

Type declaration

  • OptionalcoordinateSystem?: CoordinateSystemParams

    Optional target CoordinateSystem for export. If not provided, the SceneModel's CoordinateSystem will be used.

  • OptionalonProgress?: (progress: LoaderProgress) => void

    Optional progress callback. Same contract as ModelLoadOptions.onProgress — the exporter fires this from inside its hot loops at ≈60 Hz, paced by the same yieldToHost interval that keeps the main thread responsive.

    Exporters may reuse a single object literal across emits to avoid per-yield allocations — copy out fields you need to retain past the synchronous call.

  • Optionalsignal?: AbortSignal

    Optional AbortSignal. Exporters that have been swept to cooperative-yield check signal.aborted at every yield point and throw a DOMException("Aborted", "AbortError") when the caller cancels. Exporters that pre-date the sweep ignore this field and run to completion.

  • OptionalyieldIntervalMs?: number

    Minimum gap (in milliseconds) between cooperative yields during the export. Same contract as ModelLoadOptions.yieldIntervalMs — raise above the 16ms default to trade UI-update frequency for raw export speed on long-running exports.

Settings

Member Visibility