LegendSettings#

class ansys.mechanical.stubs.v242.Ansys.Mechanical.Graphics.Tools.LegendSettings#

Bases: object

Represents a LegendSettings object. This object holds properties of the Standalone LegendSettings.

Overview#

GetBandColor

Gets the color of the specified band.

GetBandColorAuto

Gets whether the specified band is set to Automatic or not.

GetLowerBandValueAuto

Gets whether the lower specified band value is set to Automatic or not.

GetLowerBound

Gets lower bound value of the specified band.

GetUpperBandValueAuto

Gets whether the specified upper band value is set to Automatic or not.

GetUpperBound

Gets upper bound value of the specified band.

Reset

Resets all legend customizations into default values.

ResetColors

Resets all colors to default values.

SetBandColor

Sets the color of the specified band.

SetBandColorAuto

Sets the specified band to Automatic.

SetLowerBound

Sets lower bound value of the specified band.

SetUpperBound

Sets upper bound value of the specified band.

AllScientificNotation

Whether the result values are displayed in scientific notation.

ColorScheme

Color Scheme for the legend.

Digits

Number of significant digits (min:2 , max:8).

HighFidelity

Whether to replot and improve the synchronization of the result values.

LogarithmicScale

Whether the result values are distributed in a Logarithmic scale.

NumberOfBands

Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend.

SemiTransparency

Whether the legend is semi-transparent.

Unit

The unit for the legend.

Property detail#

property LegendSettings.AllScientificNotation: bool | None#

Whether the result values are displayed in scientific notation.

property LegendSettings.ColorScheme: Ansys.Mechanical.DataModel.Enums.LegendColorSchemeType | None#

Color Scheme for the legend.

property LegendSettings.Digits: int | None#

Number of significant digits (min:2 , max:8).

property LegendSettings.HighFidelity: bool | None#

Whether to replot and improve the synchronization of the result values.

property LegendSettings.LogarithmicScale: bool | None#

Whether the result values are distributed in a Logarithmic scale.

property LegendSettings.NumberOfBands: int | None#

Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend.

property LegendSettings.SemiTransparency: bool | None#

Whether the legend is semi-transparent.

property LegendSettings.Unit: str | None#

The unit for the legend.

Method detail#

LegendSettings.GetBandColor(index: int) int#

Gets the color of the specified band.

LegendSettings.GetBandColorAuto(index: int) bool#

Gets whether the specified band is set to Automatic or not.

LegendSettings.GetLowerBandValueAuto(index: int) bool#

Gets whether the lower specified band value is set to Automatic or not.

LegendSettings.GetLowerBound(index: int) Ansys.Core.Units.Quantity#

Gets lower bound value of the specified band.

LegendSettings.GetUpperBandValueAuto(index: int) bool#

Gets whether the specified upper band value is set to Automatic or not.

LegendSettings.GetUpperBound(index: int) Ansys.Core.Units.Quantity#

Gets upper bound value of the specified band.

LegendSettings.Reset() None#

Resets all legend customizations into default values.

LegendSettings.ResetColors() None#

Resets all colors to default values.

LegendSettings.SetBandColor(index: int, colorValue: int) None#

Sets the color of the specified band.

LegendSettings.SetBandColorAuto(index: int, val: bool) None#

Sets the specified band to Automatic.

LegendSettings.SetLowerBound(index: int, value: Ansys.Core.Units.Quantity) None#

Sets lower bound value of the specified band.

LegendSettings.SetUpperBound(index: int, value: Ansys.Core.Units.Quantity) None#

Sets upper bound value of the specified band.