getSnapShot Method

Gets a snapshot of the window.

getSnapShot([width], [height], [toFile]);

 

Parameter

Description

width

Optional, default: undefined. If the width is not specified, the snapshot is created with the current 3D window width.

The width of the snapshot

height

Optional, default: undefined. If the height is not specified, the snapshot is created with the current 3D window height.

The height of the snapshot

toFile

Optional, default: false

Boolean. Indicates whether the snapshot should be saved to a file (true) or opens a dialog window with the snapshot image. If the snapshot is saved to a file, the return value is a string defining the local path name of the file

Return Value

The Local filename of the file where the snapshot was saved in the local temporary directory.

Remarks

If none of the parameters is specified, the method opens a snapshot dialog with the current width and height