ArrowSettings

class ansys.aedt.core.visualization.post.field_data.ArrowSettings(arrow_type='Line', arrow_size=0.005, map_size=False, map_color=True, show_arrow_tail=False, magnitude_filtering=False, magnitude_threshold=0, min_magnitude=0, max_magnitude=0.5)

Provides methods and variables for editing arrow folder settings.

Parameters:

arrow_typestr, optional

The type of arrows to use. Must be one of the allowed types (“Line”, “Cylinder”, “Umbrella”). Default is “Line”.

arrow_sizefloat, optional

Size of the arrow. Default is 0.005.

map_sizebool, optional

Whether to map the field magnitude to the arrow type. Default is False.

map_colorbool, optional

Whether to map the field magnitude to the arrow color. Default is True.

show_arrow_tailbool, optional

Whether to show the arrow tail. Default is False.

magnitude_filteringbool, optional

Whether to filter the field magnitude for plotting vectors. Default is False.

magnitude_thresholdbool, optional

Threshold value for plotting vectors. Default is 0.

min_magnitudebool, optional

Minimum value for plotting vectors. Default is 0.

max_magnitudebool, optional

Maximum value for plotting vectors. Default is 0.5.

Methods

ArrowSettings.from_dict(dictionary)	Initialize the arrow settings of the field plot settings from a dictionary.
ArrowSettings.to_dict()	Convert the arrow settings to a dictionary.

Attributes

ArrowSettings.arrow_type

Get the type of arrows used in the field plot.