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

• The image file includes only the contents of the window, not the title, border, etc.

• The type is not case sensitive.

• JPEG is a lossy compression, meaning that the output image will not be identical to the original. There is a trade-off between the quality of the image file and its size. The quality value is a number between 1 and 100, where 100 is the highest quality image and 1 is the lowest. A quality value of 75 is recommended.

• This function is preferable to using SaveLayoutToBitmap() or SaveLayoutToJPEG().

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