window

Provides access to the application's 3D Window. The following method is available:

§  getSnapShot()

getSnapShot

getSnapShot(options)

Takes a snapshot of the 3D Window. The snapshot can be displayed in a dialog box or saved to the hard drive.

Parameters

Name

Type

Description

 

options

 

Object

Name

Type

Description

toFile

Boolean

A Boolean that indicates whether the snapshot should be saved to a file (TRUE) or whether a window should be opened with the snapshot image (FALSE).

width

Number

The width of the snapshot in pixels. If no width is specified, this is set to the current width of the 3D Window.

height

Number

The height of the snapshot. If no height is set, this is set to the current height of the 3D Window.

format

String

A string defining the format and compression of the image file.

quality

Number

Defines the jpeg quality, when format is set to “jpeg”.

terrainQuality

Boolean

Boolean that determines the terrain database resolution for the snapshot:

§  FALSE – Take snapshot immediately using the resolution levels that already loaded.

§  TRUE – Wait until terrain database completely loads before taking the snapshot.

filename

String

Name of the file to which to save the snapshot. This option is only valid if the toFile option was set to TRUE. The file is saved in your downloads folder.

 

Example

TerraExplorer.window.getSnapShot({toFile:true, fileName:'test'});