SnapshotConfig
-
class
SnapshotConfig() This class contains configuration properties for creating viewer snapshots.
Constructors
Constructors
-
SnapshotConfig.constructor(width, height, layers, viewKey) Arguments: - width (
number()) – None - height (
number()) – None - layers (
SnapshotLayer()) – None - viewKey (
ViewKey()) – None
Creates a new SnapshotConfig object.
Return type: SnapshotConfig - width (
Properties
-
SnapshotConfig.height Type: 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 Type: SnapshotLayer Indicates which layers to include in the snapshot. The default value is [[SnapshotLayer.All]].
-
SnapshotConfig.viewKey Type: ViewKey Specifies which view the screenshot will be of. the default value is 0.
-
SnapshotConfig.width Type: 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.