Image1D, Image2D, Image3D

Export an image.

Syntax

model.result().export().create(<ftag>,"Image1D");

model.result().export().create(<ftag>,"Image2D");

model.result().export().create(<ftag>,"Image3D");

model.result().export().create(<ftag>,<pgtag>,"Image1D");

model.result().export().create(<ftag>,<pgtag>,"Image2D");

model.result().export().create(<ftag>,<pgtag>,"Image3D");

model.result().export(<ftag>).set(property, <value>);

model.result().export(<ftag>).run();

Description

model.result().export().create(<ftag>,"Image1D") creates a 1D image feature with the name <ftag>.

model.result().export().create(<ftag>,<pgtag>,"Image1D") creates a 1D image feature with the name <ftag> for the plot group <pgtag>.

result().export(<ftag>).set("plotgroup", <ptag>) changes the source of the image to the plot group named <ptag>.

Image features can be used both to export images and to have ready-made views of plot groups.

The following properties are available:

Table 7-36: Valid Property/Value Pairs for Image Export

name	Value	Default	Description
alwaysask	on | off	off	Always ask for filename when saving. This property is ignored when running without a GUI.
antialias	on | off	on	Enable/disable antialiasing.
axes	on | off	on	If options is on; enable/disable display of the coordinate axes. Used for 1D and 2D plots.
axisorientation	on | off	on	If options is on; enable/disable display of the axis orientation indicator. Used for 3D plots.
background	current | color | transparent	color	The background color.
bmpfilename	String		The name of the output file if imagetype is bmp.
customcolor	double array	{1, 1, 1}	If background is color; the red, green, and blue components of the background color.
epsfilename	String		The name of the output file if imagetype is eps.
fontsize	integer	9	The font size.
grid	on | off	on	If options is on; enable/disable display of the coordinate grid. Used for 3D plots.
height	double	600	The height of the image.
imagetype	png | eps | jpeg | bmp	png	The type of image to export; eps can only be used for 1D plots.
jpegfilename	String		The name of the output file if imagetype is jpeg.
legend	on | off	on	If options is on; enable/disable display of the legend.
lockratio	Boolean	false	If true, then the aspect ratio of the image is preserved when the width or the height is changed.
logo	on | off	on	If options is on; enable/disable display of the logotype.
options	on | off	off	Enable/disable optional components of the image.
pngfilename	String		The name of the output file if imagetype is png.
resolution	integer	96	The frame resolution in dots per inch.
plotgroup	String		The plot group to export.
title	on | off	on	If options is on; enable/disable display of the title.
unit	px | mm | in	mm	The unit for the dimensions of the image.
width	double	800	The width of the image.

The default values listed are valid before any image has been exported successfully. After that, the settings from the last successful image export are used as default values the next time an image export feature is created.

Changing plot group after creation does not reset plot group-dependent default settings (title, colorlegend).

See Also

Animation