SnapshotConfig

class Communicator.SnapshotConfig()

This class contains configuration properties for creating viewer snapshots.

Constructors

constructor()

Creates a new SnapshotConfig object.

Properties

height	Specifies the width of the resulting snapshot image. A…
layers	Indicates which layers to include in the snapshot. The…
width	Specifies the width of the resulting snapshot image. A…

---

Constructors

constructor

Communicator.SnapshotConfig.constructor(width, height, layers)

Creates a new SnapshotConfig object.

Arguments

• width ({  }()) –

• height ({  }()) –

• layers (Communicator.SnapshotLayer()) –

Return type

Communicator.SnapshotConfig

Properties

Communicator.SnapshotConfig.height

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

Communicator.SnapshotConfig.layers

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

Communicator.SnapshotConfig.width

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