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#
|
Gets lower bound value of the specified band. |
|
Sets lower bound value of the specified band. |
|
Gets upper bound value of the specified band. |
|
Sets upper bound value of the specified band. |
|
Gets the color of the specified band. |
|
Sets the color of the specified band. |
|
Gets whether the specified band is set to Automatic or not. |
|
Sets the specified band to Automatic. |
|
Gets whether the specified upper band value is set to Automatic or not. |
|
Gets whether the lower specified band value is set to Automatic or not. |
|
Resets all colors to default values. |
|
Resets all legend customizations into default values. |
|
Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend. |
|
Whether the result values are displayed in scientific notation. |
|
Number of significant digits (min:2 , max:8). |
|
Color Scheme for the legend. |
|
Whether the legend is semi-transparent. |
|
Whether the result values are distributed in a Logarithmic scale. |
|
Whether to replot and improve the synchronization of the result values. |
|
The unit for the legend. |
Property detail#
- property LegendSettings.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 LegendSettings.AllScientificNotation: System.Boolean | None
Whether the result values are displayed in scientific notation.
- property LegendSettings.Digits: System.Int32 | None
Number of significant digits (min:2 , max:8).
- property LegendSettings.ColorScheme: Ansys.Mechanical.DataModel.Enums.LegendColorSchemeType | None
Color Scheme for the legend.
- property LegendSettings.SemiTransparency: System.Boolean | None
Whether the legend is semi-transparent.
- property LegendSettings.LogarithmicScale: System.Boolean | None
Whether the result values are distributed in a Logarithmic scale.
- property LegendSettings.HighFidelity: System.Boolean | None
Whether to replot and improve the synchronization of the result values.
- property LegendSettings.Unit: System.String | None
The unit for the legend.
Method detail#
- LegendSettings.GetLowerBound(index: System.Int32) Ansys.Core.Units.Quantity
Gets lower bound value of the specified band.
- LegendSettings.SetLowerBound(index: System.Int32, value: Ansys.Core.Units.Quantity) System.Void
Sets lower bound value of the specified band.
- LegendSettings.GetUpperBound(index: System.Int32) Ansys.Core.Units.Quantity
Gets upper bound value of the specified band.
- LegendSettings.SetUpperBound(index: System.Int32, value: Ansys.Core.Units.Quantity) System.Void
Sets upper bound value of the specified band.
- LegendSettings.GetBandColor(index: System.Int32) System.UInt32
Gets the color of the specified band.
- LegendSettings.SetBandColor(index: System.Int32, colorValue: System.UInt32) System.Void
Sets the color of the specified band.
- LegendSettings.GetBandColorAuto(index: System.Int32) System.Boolean
Gets whether the specified band is set to Automatic or not.
- LegendSettings.SetBandColorAuto(index: System.Int32, val: System.Boolean) System.Void
Sets the specified band to Automatic.
- LegendSettings.GetUpperBandValueAuto(index: System.Int32) System.Boolean
Gets whether the specified upper band value is set to Automatic or not.
- LegendSettings.GetLowerBandValueAuto(index: System.Int32) System.Boolean
Gets whether the lower specified band value is set to Automatic or not.
- LegendSettings.ResetColors() System.Void
Resets all colors to default values.
- LegendSettings.Reset() System.Void
Resets all legend customizations into default values.