HeatmapPaletteColorProvider.LegendItemPattern Property

Gets or sets the format string that configures legend item text.

Namespace: DevExpress.XtraCharts.Heatmap

Assembly: DevExpress.XtraCharts.v21.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public string LegendItemPattern { get; set; }

VB.NET

Public Property LegendItemPattern As String

Property Value

Type	Description
String	A format string.

Remarks

The LegendItemPattern can contain regular text (displayed as is) and value placeholders in braces. To format numeric values, you can apply Format Specifiers. Use a colon to separate a placeholder and its format specifier.

The following table contains the available placeholders for the HeatmapRangeColorProvider:

Placeholder	Description
{V1}	Displays a start range value.
{V2}	Displays a end range value.
{VP1}	Displays a start range value as percentage.
{VP2}	Displays a end range value as percentage.

The following table contains the available placeholders for the HeatmapKeyColorProvider:

Placeholder	Description
{V}	Displays a key value.

In the following image, the “{VP1:0%} - {VP2:0%}” format string is applied to legend items:

C#

heatmapRangeColorProvider.LegendItemPattern = "{VP1:0%} - {VP2:0%}";

VB.NET

heatmapRangeColorProvider.LegendItemPattern = "{VP1:0%} - {VP2:0%}"