SnapshotRestoreOptions

Interface SnapshotRestoreOptions

Options used for restoring a snapshot.

These options allow customization of the snapshot restoration process, enabling selective restoration of specific elements such as annotations, camera settings, or measurements.

Use Case

Use this type to configure the snapshot restoration process. For example, you can choose to restore only the camera settings or specific elements of the session state.

See

SessionStorageAPI

interface SnapshotRestoreOptions {
    restoreAnnotations?: boolean;
    restoreBackground?: boolean;
    restoreCamera?: boolean;
    restoreClipPlanes?: boolean;
    restoreClipRoom?: boolean;
    restoreDrawingPlanes?: boolean;
    restoreDrawings?: boolean;
    restoreLayerFilter?: boolean;
    restoreMeasurements?: boolean;
    restoreSelection?: boolean;
    restoreTree?: boolean;
}

Properties

restoreAnnotations? restoreBackground? restoreCamera? restoreClipPlanes? restoreClipRoom? restoreDrawingPlanes? restoreDrawings? restoreLayerFilter? restoreMeasurements? restoreSelection? restoreTree?

Properties

OptionalrestoreAnnotations

restoreAnnotations?: boolean

Specifies whether annotations should be restored.

Default

true

OptionalrestoreBackground

restoreBackground?: boolean

Specifies whether the background should be restored when restoring camera settings.

Default

true

OptionalrestoreCamera

restoreCamera?: boolean

Specifies whether the camera settings should be restored.

Default

true

OptionalrestoreClipPlanes

restoreClipPlanes?: boolean

Specifies whether clip planes should be restored.

Default

true

OptionalrestoreClipRoom

restoreClipRoom?: boolean

Specifies whether the clip room should be restored.

Default

true

OptionalrestoreDrawingPlanes

restoreDrawingPlanes?: boolean

Specifies whether drawing planes should be restored.

Default

true

OptionalrestoreDrawings

restoreDrawings?: boolean

Specifies whether drawings should be restored.

Default

true

OptionalrestoreLayerFilter

restoreLayerFilter?: boolean

Specifies whether the layer filter should be restored.

Default

true

OptionalrestoreMeasurements

restoreMeasurements?: boolean

Specifies whether measurements should be restored.

Default

true

OptionalrestoreSelection

restoreSelection?: boolean

Specifies whether the selection state should be restored.

Default

true

OptionalrestoreTree

restoreTree?: boolean

Specifies whether the tree structure should be restored.

Default

true