SnapshotConfig

class Communicator.SnapshotConfig()

This class contains configuration properties for creating viewer snapshots.

Constructors

• constructor()

Properties

• height

• layers

• width

---

Constructors

SnapshotConfig.constructor([width[, height[, layers]]])

Creates a new SnapshotConfig object.

Arguments

• width (number()) – optional

• height (number()) – optional

• layers (SnapshotLayer) – optional

Return type

SnapshotConfig()

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.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.