SnapshotConfig

class SnapshotConfig()

This class contains configuration properties for creating viewer snapshots.

Index

Constructors

• constructor

Properties

• height
• layers
• viewKey
• width

Constructors

SnapshotConfig.constructor()

SnapshotConfig(width: number?, height: number?, layers: SnapshotLayer?, viewKey: ViewKey?): SnapshotConfig

Creates a new SnapshotConfig object.

Parameters

width: number = 0

height: number = 0

layers: SnapshotLayer = SnapshotLayer.All

viewKey: ViewKey = ViewKey.Default

Returns: SnapshotConfig

Properties

SnapshotConfig.height

height: number

Specifies the width of the resulting snapshot image. A value of 0 indicates the canvas width should be used. The default value is 0.

SnapshotConfig.layers

layers: SnapshotLayer

Indicates which layers to include in the snapshot. The default value is [[SnapshotLayer.All]].

SnapshotConfig.viewKey

viewKey: ViewKey

Specifies which view the screenshot will be of. the default value is 0.

SnapshotConfig.width

width: number

Specifies the width of the resulting snapshot image. A value of 0 indicates the canvas width should be used. The default value is 0.