SnapshotCreationOptions¶
Interface SnapshotCreationOptions
interface SnapshotCreationOptions {
storeBackground?: boolean;
thumbnail?: boolean;
thumbnailHeight?: number;
thumbnailWidth?: number;
}
storeBackground?: boolean;
thumbnail?: boolean;
thumbnailHeight?: number;
thumbnailWidth?: number;
}
Index
Properties
Optionalstore
storeBackground?: boolean
Specifies whether the viewer's background should be stored in the snapshot.
Optionalthumbnail
thumbnail?: boolean
Specifies whether a thumbnail should be created for the snapshot.
Optionalthumbnail
thumbnailHeight?: number
Specifies the height of the thumbnail in pixels.
If neither thumbnailHeight nor thumbnailWidth is set, the current viewer size will be used.
Optionalthumbnail
thumbnailWidth?: number
Specifies the width of the thumbnail in pixels.
If neither thumbnailHeight nor thumbnailWidth is set, the current viewer size will be used.
Options used for the creation of a snapshot. These options allow customization of the snapshot creation process.
Use Case
Use this type to configure the snapshot creation process. For example, you can specify whether a thumbnail should be created and define its dimensions if needed.
See
SessionStorageAPI