FormatRuleCollection<T, TColumnType>.Add3ColorScale(TColumnType, Color, Color, Color, FormatConditionValueType, FormatConditionValueType, FormatConditionValueType, Decimal, Decimal, Decimal) Method
Applies a format that uses a range of colors to illustrate data distribution. You can specify the minimum, maximum, and midpoint values, and colors for them.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v24.2.dll
NuGet Package: DevExpress.Win.Navigation
#Declaration
public T Add3ColorScale(
TColumnType column,
Color minColor,
Color midColor,
Color maxColor,
FormatConditionValueType minType = FormatConditionValueType.Automatic,
FormatConditionValueType midType = FormatConditionValueType.Automatic,
FormatConditionValueType maxType = FormatConditionValueType.Automatic,
decimal minValue = 0M,
decimal midValue = 0M,
decimal maxValue = 0M
)
#Parameters
Name | Type | Description |
---|---|---|
column | TColumn |
A {TColumn |
min |
Color | The color that corresponds to the minimum threshold. This value is assigned to the Minimum |
mid |
Color | The color that corresponds to the midpoint of the target value range. This value is assigned to the Middle |
max |
Color | The color that corresponds to the maximum threshold. This value is assigned to the Maximum |
#Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
min |
Format |
Automatic | A value that specifies whether the minimum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the Minimum |
mid |
Format |
Automatic | A value that specifies whether the midpoint value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the Middle |
max |
Format |
Automatic | A value that specifies whether the maximum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the Maximum |
min |
Decimal | 0 | The minimum value of the target range. This value is assigned to the Minimum property. |
mid |
Decimal | 0 | The midpoint of the target value range. This value is assigned to the Middle property. |
max |
Decimal | 0 | The maximum value of the target range. This value is assigned to the Maximum property. |
#Returns
Type | Description |
---|---|
T | A {T} object that specifies a format. |