MarkerSettings#

class ansys.aedt.core.visualization.post.field_data.MarkerSettings(marker_type='Box', map_size=False, map_color=True, marker_size=0.005)[source]#

Provides methods and variables for editing marker folder settings.

Parameters:
marker_typestr, optional

The type of maker to use. Must be one of the allowed types (“Octahedron”, “Tetrahedron”, “Sphere”, “Box”, “Arrow”). Default is “Box”.

marker_sizefloat, optional

Size of the marker. 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.

Methods

MarkerSettings.from_dict(dictionary)

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

MarkerSettings.to_dict()

Convert the marker settings to a dictionary.

Attributes

MarkerSettings.marker_type

Get the type of maker to use.