LegendSettings

class ansys.mechanical.stubs.v261.Ansys.Mechanical.Graphics.Tools.LegendSettings(unit: str)

Bases: object

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

Overview

Methods

CopyTo	CopyTo method.
Equals	Equals method.
ExportLegend	ExportLegend method.
GetBandColor	Gets the color of the specified band.
GetBandColorAuto	Gets whether the specified band is set to Automatic or not.
GetHashCode	GetHashCode method.
GetLowerBandValueAuto	Gets whether the lower specified band value is set to Automatic or not.
GetLowerBound	Gets lower bound value of the specified band.
GetType	GetType method.
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.
SetLowerBandValueAuto	SetLowerBandValueAuto method.
SetLowerBound	Sets lower bound value of the specified band.
SetMinMax	SetMinMax method.
SetUpperBandValueAuto	SetUpperBandValueAuto method.
SetUpperBound	Sets upper bound value of the specified band.
ToString	ToString method.

Properties

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.
Max	Max property.
Min	Min property.
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.Max: Ansys.Core.Units.Quantity | None

Max property.

property LegendSettings.Min: Ansys.Core.Units.Quantity | None

Min property.

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.CopyTo(activeLegend: Ansys.Mechanical.Graphics.Tools.CurrentLegendSettings) → None

CopyTo method.

LegendSettings.Equals(obj: Any) → bool

Equals method.

LegendSettings.ExportLegend(filePath: str) → None

ExportLegend method.

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.GetHashCode() → int

GetHashCode method.

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.GetType() → type

GetType method.

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.SetLowerBandValueAuto(index: int, val: bool) → None

SetLowerBandValueAuto method.

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

Sets lower bound value of the specified band.

LegendSettings.SetMinMax(min: Ansys.Core.Units.Quantity, max: Ansys.Core.Units.Quantity) → None

SetMinMax method.

LegendSettings.SetUpperBandValueAuto(index: int, val: bool) → None

SetUpperBandValueAuto method.

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

Sets upper bound value of the specified band.

LegendSettings.ToString() → str

ToString method.