export_field_jpg#

PostProcessorIcepak.export_field_jpg(file_name, plot_name, folder_name, orientation='isometric', width=1920, height=1080, display_wireframe=True, selections=None, show_axis=True, show_grid=True, show_ruler=True, show_region='Default')#

Export a field plot and coordinate system to a JPG file.

Parameters:
file_namestr

Full path and name to save the JPG file to.

plot_namestr

Name of the plot.

folder_namestr

Name of the folder plot.

orientationstr, optional

Name of the orientation to apply. The default is "isometric".

widthint, optional

Plot Width. The default is 1920.

heightint, optional

Plot Height. The default is 1080.

display_wireframebool, optional

Display wireframe. The default is True.

selectionslist, optional
List of objects to include in the plot.

Supported in 3D Field Plots only starting from 23R1.

show_axisbool, optional

Whether to show the axes. The default is True. Supported in 3D Field Plots only starting from 23R1.

show_gridbool, optional

Whether to show the grid. The default is True. Supported in 3D Field Plots only starting from 23R1.

show_rulerbool, optional

Whether to show the ruler. The default is True. Supported in 3D Field Plots only starting from 23R1.

show_regionbool, optional

Whether to show the region or not. The default is Default. Supported in 3D Field Plots only starting from 23R1.

Returns:
bool

True when successful, False when failed.

References

>>> oModule.ExportPlotImageToFile
>>> oModule.ExportModelImageToFile