CurrentLegendSettings

class ansys.mechanical.stubs.v242.Ansys.Mechanical.Graphics.Tools.CurrentLegendSettings

Bases: object

Represents a CurrentLegendSettings object. This object holds properties of the CurrentLegendSettings.

Overview

Methods

GetBandColor	Gets the color of the specified band.
SetBandColor	Sets the color of the specified band.
GetLowerBound	Gets lower bound value of the specified band.
SetLowerBound	Sets lower bound value of the specified band.
GetUpperBound	Gets upper bound value of the specified band.
SetUpperBound	Sets upper bound value of the specified band.
GetBandColorAuto	Gets whether the specified band is set to Automatic or not.
SetBandColorAuto	Sets the specified band to Automatic.
GetUpperBandValueAuto	Gets whether the specified upper band value is set to Automatic or not.
GetLowerBandValueAuto	Gets whether the specified lower band value is set to Automatic or not.
ResetColors	Resets all colors to default values.
Reset	Resets all legend customizations into default values.
MakeCopy	Makes a copy of the CurrentLegendSettings object.

Properties

NumberOfBands	Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend.
AllScientificNotation	Whether the result values are displayed in scientific notation.
Digits	Number of significant digits(min:2, max:8).
ColorScheme	Color Scheme for the legend.
SemiTransparency	Whether the legend is semi-transparent.
LogarithmicScale	Whether the result values are distributed in a Logarithmic scale.
HighFidelity	Whether to replot and improve the synchronization of the result values.

Property detail

property CurrentLegendSettings.NumberOfBands: System.Int32 | None

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

property CurrentLegendSettings.AllScientificNotation: System.Boolean | None

Whether the result values are displayed in scientific notation.

property CurrentLegendSettings.Digits: System.Int32 | None

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

property CurrentLegendSettings.ColorScheme: Ansys.Mechanical.DataModel.Enums.LegendColorSchemeType | None

Color Scheme for the legend.

property CurrentLegendSettings.SemiTransparency: System.Boolean | None

Whether the legend is semi-transparent.

property CurrentLegendSettings.LogarithmicScale: System.Boolean | None

Whether the result values are distributed in a Logarithmic scale.

property CurrentLegendSettings.HighFidelity: System.Boolean | None

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

Method detail

CurrentLegendSettings.GetBandColor(index: System.Int32) → System.UInt32

Gets the color of the specified band.

CurrentLegendSettings.SetBandColor(index: System.Int32, ColorValue: System.UInt32) → System.Void

Sets the color of the specified band.

CurrentLegendSettings.GetLowerBound(index: System.Int32) → Ansys.Core.Units.Quantity

Gets lower bound value of the specified band.

CurrentLegendSettings.SetLowerBound(index: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void

Sets lower bound value of the specified band.

CurrentLegendSettings.GetUpperBound(index: System.Int32) → Ansys.Core.Units.Quantity

Gets upper bound value of the specified band.

CurrentLegendSettings.SetUpperBound(index: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void

Sets upper bound value of the specified band.

CurrentLegendSettings.GetBandColorAuto(index: System.Int32) → System.Boolean

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

CurrentLegendSettings.SetBandColorAuto(index: System.Int32, val: System.Boolean) → System.Void

Sets the specified band to Automatic.

CurrentLegendSettings.GetUpperBandValueAuto(index: System.Int32) → System.Boolean

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

CurrentLegendSettings.GetLowerBandValueAuto(index: System.Int32) → System.Boolean

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

CurrentLegendSettings.ResetColors() → System.Void

Resets all colors to default values.

CurrentLegendSettings.Reset() → System.Void

Resets all legend customizations into default values.

CurrentLegendSettings.MakeCopy() → Ansys.Mechanical.Graphics.Tools.LegendSettings

Makes a copy of the CurrentLegendSettings object.