## On this page

  

 

 # `CurrentLegendSettings`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.Mechanical.Graphics.Tools.CurrentLegendSettings"></a>

#### *class* Ansys.Mechanical.Graphics.Tools.CurrentLegendSettings

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

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

<a id="overview"></a>

## Overview

### Methods

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

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

## Property detail

<a id="CurrentLegendSettings.AllScientificNotation"></a>

### *property* CurrentLegendSettings.AllScientificNotation *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Whether the result values are displayed in scientific notation.

<a id="CurrentLegendSettings.ColorScheme"></a>

### *property* CurrentLegendSettings.ColorScheme *: [Ansys.Mechanical.DataModel.Enums.LegendColorSchemeType](../../DataModel/Enums/LegendColorSchemeType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.LegendColorSchemeType) | [None](https://docs.python.org/3/library/constants.html#None)*

Color Scheme for the legend.

<a id="CurrentLegendSettings.Digits"></a>

### *property* CurrentLegendSettings.Digits *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="CurrentLegendSettings.HighFidelity"></a>

### *property* CurrentLegendSettings.HighFidelity *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="CurrentLegendSettings.LogarithmicScale"></a>

### *property* CurrentLegendSettings.LogarithmicScale *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Whether the result values are distributed in a Logarithmic scale.

<a id="CurrentLegendSettings.NumberOfBands"></a>

### *property* CurrentLegendSettings.NumberOfBands *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="CurrentLegendSettings.SemiTransparency"></a>

### *property* CurrentLegendSettings.SemiTransparency *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Whether the legend is semi-transparent.

<a id="method-detail"></a>

## Method detail

<a id="CurrentLegendSettings.GetBandColor"></a>

### CurrentLegendSettings.GetBandColor(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the color of the specified band.

<a id="CurrentLegendSettings.GetBandColorAuto"></a>

### CurrentLegendSettings.GetBandColorAuto(index: [int](https://docs.python.org/3/library/functions.html#int))

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

<a id="CurrentLegendSettings.GetLowerBandValueAuto"></a>

### CurrentLegendSettings.GetLowerBandValueAuto(index: [int](https://docs.python.org/3/library/functions.html#int))

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

<a id="CurrentLegendSettings.GetLowerBound"></a>

### CurrentLegendSettings.GetLowerBound(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets lower bound value of the specified band.

<a id="CurrentLegendSettings.GetUpperBandValueAuto"></a>

### CurrentLegendSettings.GetUpperBandValueAuto(index: [int](https://docs.python.org/3/library/functions.html#int))

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

<a id="CurrentLegendSettings.GetUpperBound"></a>

### CurrentLegendSettings.GetUpperBound(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets upper bound value of the specified band.

<a id="CurrentLegendSettings.MakeCopy"></a>

### CurrentLegendSettings.MakeCopy()

Makes a copy of the CurrentLegendSettings object.

<a id="CurrentLegendSettings.Reset"></a>

### CurrentLegendSettings.Reset()

Resets all legend customizations into default values.

<a id="CurrentLegendSettings.ResetColors"></a>

### CurrentLegendSettings.ResetColors()

Resets all colors to default values.

<a id="CurrentLegendSettings.SetBandColor"></a>

### CurrentLegendSettings.SetBandColor(index: [int](https://docs.python.org/3/library/functions.html#int), ColorValue: [int](https://docs.python.org/3/library/functions.html#int))

Sets the color of the specified band.

<a id="CurrentLegendSettings.SetBandColorAuto"></a>

### CurrentLegendSettings.SetBandColorAuto(index: [int](https://docs.python.org/3/library/functions.html#int), val: [bool](https://docs.python.org/3/library/functions.html#bool))

Sets the specified band to Automatic.

<a id="CurrentLegendSettings.SetLowerBound"></a>

### CurrentLegendSettings.SetLowerBound(index: [int](https://docs.python.org/3/library/functions.html#int), value: Ansys.Core.Units.Quantity)

Sets lower bound value of the specified band.

<a id="CurrentLegendSettings.SetUpperBound"></a>

### CurrentLegendSettings.SetUpperBound(index: [int](https://docs.python.org/3/library/functions.html#int), value: Ansys.Core.Units.Quantity)

Sets upper bound value of the specified band.