Routines (alphabetical) > Routines: X > XOBJVIEW_WRITE_IMAGE

# XOBJVIEW_WRITE_IMAGE

The XOBJVIEW_WRITE_IMAGE procedure is used to write the object currently displayed in XOBJVIEW to an image file with the specified name and file format. XOBJVIEW must be called prior to calling XOBJVIEW_WRITE_IMAGE.

This routine is written in the IDL language. Its source code can be found in the file `xobjview_write_image.pro` in the `lib/utilities` subdirectory of the IDL distribution.

## Examples

See XOBJVIEW_ROTATE.

## Syntax

XOBJVIEW_WRITE_IMAGE, Filename, Format [, DIMENSIONS=[x, y] ]

## Arguments

### Filename

A scalar string containing the name of the file to write.

### Format

A scalar string containing the name of the file format to write. See WRITE_IMAGE for a list of supported formats.

## Keywords

### DIMENSIONS

Set this keyword to a 2-element vector of the form [x, y] specifying the size of the output image, in pixels. If this keyword is not specified, the image will be written using the dimensions of the current XOBJVIEW draw widget.

## Version History

5.5 | Introduced

## See Also

XOBJVIEW, XOBJVIEW_ROTATE