ColorMapSettings

class ansys.aedt.core.visualization.post.field_data.ColorMapSettings(map_type: str = 'Spectrum', color: str = 'Rainbow')

Provides methods and variables for editing color map folder settings.

Parameters:

map_typestr, optional

The type of colormap to use. Must be one of the allowed types (“Spectrum”, “Ramp”, “Uniform”). Default is “Spectrum”.

colorstr or list[float], optional

Color to use. If “Spectrum” color map, a string is expected. Else a list of 3 values (R,G,B). Default is “Rainbow”.

Examples

>>> from ansys.aedt.core.visualization.post.field_data import ColorMapSettings
>>> obj = ColorMapSettings()

Methods

ColorMapSettings.from_dict(settings)	Initialize the number format settings of the colormap settings from a dictionary.
ColorMapSettings.to_dict()	Convert the color map settings to a dictionary.

Attributes

ColorMapSettings.color	Get the color based on the map type.
ColorMapSettings.map_type	Get the color map type for the field plot.
ColorMapSettings.public_dir	Shortcut for dir(self).