Image (Export)

Export an image.

Syntax

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

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

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

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

Description

model.result().export().create(<ftag>,"Image") creates an image feature with the name <ftag>.

model.result().export().create(<ftag>,<pgtag>,"Image") creates am 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-53: Valid Property/Value Pairs for Image Export
name	Value	Default	Description
alwaysask	on \| off	off	Always ask for filename when saving if target is set to file. This property is ignored when running without a GUI.
antialias	on \| off	on	Enable/disable antialiasing.
axes1d	on \| off	on	If options1d is on; enable/disable display of the coordinate axes in 1D.
axes2d	on \| off	on	If options2d is on; enable/disable display of the coordinate axes in 2D.
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.
gltfincludelines	on \| off	on	Include line segments if imagetype is gltf.
gltffilename	String		The name of the output file if imagetype is gltf.
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 \| gltf	png	The type of image to export if target is set to file. eps can only be used for 1D plots. gltf can only be used for 3D plots.
jpegfilename	String		The name of the output file if imagetype is jpeg.
legend1d	on \| off	on	If options1d is on: enable or disable display of the legend in 1D.
legend2d	on \| off	on	If options2d is on: enable or disable display of the legend in 2D.
legend3d	on \| off	on	If options3d is on: enable or disable display of the legend in 3D.
lockratio	true \| false	false	If true, then the aspect ratio of the image is preserved when the width or the height is changed.
lockview	true \| false	false	Lock the view in PowerPoint or Word if target is set to linked. Saved camera settings are then used when you update the image from PowerPoint or Word.
logo1d	on \| off	on	If options1d is on: enable or disable display of the logo in 1D.
logo2d	on \| off	on	If options2d is on: enable or disable display of the logo in 2D.
logo3d	on \| off	on	If options3d is on: enable or disable display of the logo in 3D.
options1d	on \| off	off	Enable/disable optional components of the image in 1D.
options2d	on \| off	off	Enable/disable optional components of the image in 2D.
options3d	on \| off	off	Enable/disable optional components of the image in 3D.
pngfilename	String		The name of the output file if imagetype is png.
qualityactive	on \| off	off	If a quality level (quantitylevel) should be active when imagetype is jpeg.
quantitylevel	integer	92	The quality level when imagetype is jpeg.
resolution	integer	96	The frame resolution in dots per inch.
plotgroup	String		The plot group to export.
size	manualprint \| manualweb \| current \| presentation \| any user-defined preset sizes.	current	The preset size. The presentation preset option is intended for export to PowerPoint and Word.
sourceobject	The tag of the node for the plot.		The tag of a node (such as a plotgroup like "pg1") with the plot for the image export.
sourcetype	plotgroup \| geometry \| other	plotgroup	The type of source for the image: A plot group, the geometry, or some other type (such as a selection or mesh),
target	file \| clipboard \| linked	file	The target for the image: a file, the Windows clipboard, or linked to PowerPoint and Word (the latter two options are only available on Windows),
title1d	on \| off	on	If options1d is on: enable or disable display of the title in 1D.
title2d	on \| off	on	If options2d is on: enable or disable display of the title in 2D.
title3d	on \| off	on	If options3d is on: enable or disable display of the title in 3D.
unit	px \| mm \| in	mm	The unit for the dimensions of the image.
view	auto \| new \| any other existing view	auto	The view for the image: with auto it is typically taken from the plot group or from the geometry.
width	double	800	The width of the image.
zoomextents	on \| off	off	Perform a zoom to extents for the image.


	The default values listed above 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).