export_field_plot

PostProcessor3D.export_field_plot(plot_name: str, output_dir: str | Path, file_name: str = '', file_format: str = 'aedtplt') → str | bool

Export a field plot.

Parameters:

plot_namestr

Name of the plot.

output_dirstr or pathlib.Path

Path for saving the file.

file_namestr, optional

Name of the file. The default is "", in which case a name is automatically assigned.

file_formatstr, optional

Name of the file extension. The default is "aedtplt". Options are "case" and "fldplt".

Returns:

str or bool

File path when successful or False when it fails.

References

>>> oModule.ExportFieldPlot

Examples

>>> from ansys.aedt.core.visualization.post.post_common_3d import PostProcessor3D
>>> obj = PostProcessor3D()
>>> obj.export_field_plot(plot_name=1, output_dir="directory")