Scale3DSettings#

class ansys.aedt.core.visualization.post.field_data.Scale3DSettings(scale_type='Auto', scale_settings=AutoScale(n_levels=10, limit_precision_digits=False, precision_digits=3, use_current_scale_for_animation=False), log=False, db=False, unit=None, number_format=NumberFormat(format_type=Automatic, width=4, precision=4))[source]#

Provides methods and variables for editing scale folder settings.

Parameters:
scale_typestr, optional

Scale type. Default is “Auto”.

scale_settingsansys.aedt.core.modules.post_general.AutoScale,

ansys.aedt.core.modules.post_general.MinMaxScale or ansys.aedt.core.modules.post_general.SpecifiedScale, optional

Scale settings. Default is AutoScale().

logbool, optional

Whether to use a log scale. Default is False.

dbbool, optional

Whether to use dB scale. Default is False.

unitint, optional

Unit to use in the scale. Default is None.

number_formatansys.aedt.core.modules.post_general.NumberFormat, optional

Number format settings. Default is NumberFormat().

Methods

Scale3DSettings.from_dict(dictionary)

Initialize the scale settings of the field plot settings from a dictionary.

Scale3DSettings.to_dict()

Convert the scale settings to a dictionary.

Attributes

Scale3DSettings.scale_settings

Get the current scale settings based on the scale type.

Scale3DSettings.scale_type

Get type of scale used for the field plot.

Scale3DSettings.unit

Get unit used in the plot.