Represents a LegendSettings object. This object holds properties of the Standalone LegendSettings.
Declaration Syntax
public class LegendSettings
Table 64: Members
|
Property | AllScientificNotation |
Whether the result values are displayed in scientific notation. |
|
Property | ColorScheme |
Color Scheme for the legend. |
|
Property | Digits |
Number of significant digits (min:2 , max:8). |
|
Property | HighFidelity |
Whether to replot and improve the synchronization of the result values. |
|
Property | LogarithmicScale |
Whether the result values are distributed in a Logarithmic scale. |
|
Property | NumberOfBands |
Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend. |
|
Property | SemiTransparency |
Whether the legend is semi-transparent. |
|
Property | Unit |
The unit for the legend. |
|
Method | GetBandColor(int) |
Gets the color of the specified band. |
|
Method | GetBandColorAuto(int) |
Gets whether the specified band is set to Automatic or not. |
|
Method | GetLowerBandValueAuto(int) |
Gets whether the lower specified band value is set to Automatic or not. |
|
Method | GetLowerBound(int) |
Gets lower bound value of the specified band. |
|
Method | GetUpperBandValueAuto(int) |
Gets whether the specified upper band value is set to Automatic or not. |
|
Method | GetUpperBound(int) |
Gets upper bound value of the specified band. |
|
Method | Reset() |
Resets all legend customizations into default values. |
|
Method | ResetColors() |
Resets all colors to default values. |
|
Method | SetBandColor(int, uint) |
Sets the color of the specified band. |
|
Method | SetBandColorAuto(int, bool) |
Sets the specified band to Automatic. |
|
Method | SetLowerBound(int, Quantity) |
Sets lower bound value of the specified band. |
|
Method | SetUpperBound(int, Quantity) |
Sets upper bound value of the specified band. |