Maptitude GISDK Help

SaveLayoutToImage()

Summary

Saves the contents of the layout window to an image file.

 

Changes

TIFF and GIF image types added to Version 6.0/2012.

 

Syntax

SaveLayoutToImage(string layout_name, string file_name, string type, array options)

 

Argument Contents
figure_name The name of the layout, or null for the current layout
file_name The path and name of the file
type Type of image file: "JPEG", "BITMAP", "TIFF", "GIF", or "PNG" (not case sensitive)

 

Option Type Contents
Quality Integer Quality of the JPEG image. The higher the quality setting, the larger the resulting JPEG files. The default quality is 80.

 

Notes

Example

SaveLayoutToImage("My Layout", "c:\\images\\layout1.jpg", "JPEG", {{"Quality", 70}} )

 

Error Codes

Error Type Meaning
Error The file_name is invalid or the file could not be created
NotFound The specified layout does not exist

 

See Also

Function Summary
SaveEditorToImage() Saves the contents of the editor window to an image file
SaveFigureToImage() Saves the contents of the figure window to an image file
SaveMapToImage() Saves the contents of the map window to an image file

 

 

©2025 Caliper Corporation www.caliper.com