Description | Example | Return Message | Group

MapSnap

Take a picture of the current 2D Graphics window and save it

Syntax

MapSnap <ScenarioPath> {SnapOption} [<Parameters>] [<WinNumber>]

Related Commands

Description

The MapSnap command allows you to take a snapshot of a specified 2D Graphics window and save it to a file or to the clipboard

{SnapOptions} and <Parameters> can be:

{SnapOption} <Parameters>
ToFile "<FilePath>"

The format in which the file is saved is determined by the file extension on the "<FilePath>". The following are valid file extensions:

  • bmp
  • ras
  • tif
  • jpg

To snap a picture to a file using more options use the SoftVTR2D command with the SnapWindow option.

ToClipboard N/A

Example

To snap a picture of 2D Graphics window #2 and save it to the Windows clipboard:

MapSnap * ToClipboard 2

To snap a picture of the first 2D Graphics window and save in bitmap format to a file:

MapSnap * ToFile "C:\MyTemp\Map1.bmp"

To snap a picture of the 2D Graphics window #2 and save in jpeg format to a file:

MapSnap * ToFile "C:\MyTemp\Map2.jpg" 2

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Graphics Window

Version

10.1

STK Programming Interface 11.0.1