export_image#

FieldPlot.export_image(full_path=None, width=1920, height=1080, orientation='isometric', display_wireframe=True, selections=None, show_region=True, show_axis=True, show_grid=True, show_ruler=True)[source]#

Export the active plot to an image file.

Note

There are some limitations on HFSS 3D Layout plots.

full_pathstr, optional: Path for saving the image file. PNG and GIF formats are supported. The default is None which export file in working_directory.
widthint, optional: Plot Width.
heightint, optional: Plot height.
orientationstr, optional: View of the exported plot. Options are isometric, top, bottom, right, left, front, back, and any custom orientation.
display_wireframebool, optional: Whether the objects has to be put in wireframe mode. Default is True.
selectionsstr or List[str], optional: Objects to fit for the zoom on the exported image. Default is None in which case all the objects in the design will be shown. One important note is that, if the fieldplot extension is larger than the selection extension, the fieldplot extension will be the one considered for the zoom of the exported image.
show_regionbool, optional: Whether to include the air region in the exported image. Default is True.
show_gridbool, optional: Whether to display the background grid in the exported image. Default is True.
show_axisbool, optional: Whether to display the axis triad in the exported image. Default is True.
show_rulerbool, optional: Whether to display the ruler in the exported image. Default is True.

Returns:

str: Full path to exported file if successful.

References

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