SnapshotCreationOptions#

Type alias SnapshotCreationOptions

SnapshotCreationOptions: {
    thumbnail?: boolean;
    thumbnailHeight?: number;
    thumbnailWidth?: number;
}

Different Options used for the Snapshot creation.

Type declaration

  • Optional thumbnail?: boolean

    Specifies if a thumbnail is created or not.

    Default

    true
    
  • Optional thumbnailHeight?: number

    Specifies the height of the thumbnail. If the thumbnail height or width is not set the current viewer size is used.

    Default

    undefined
    
  • Optional thumbnailWidth?: number

    Specifies the width of the thumbnail. If the thumbnail height or width is not set the current viewer size is used.

    Default

    undefined