HeatmapPaletteColorProvider.LegendItemPattern Property

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

Namespace: DevExpress.XtraCharts.Heatmap

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraSerializableProperty]
public string LegendItemPattern { get; set; }

VB.NET

<XtraSerializableProperty>
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%}"

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LegendItemPattern property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/Heatmap/HeatmapItemControlProvider.cs#L107

int rangesCount = rangeStops.Count;
provider.LegendItemPattern = usePercentRangeStops ? "{VP1:p0} - {VP2:p0}" : "{V1} - {V2}";
if(usePercentRangeStops) {

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/Heatmap/HeatmapItemControlProvider.vb#L108

Dim rangesCount As Integer = rangeStops.Count
provider.LegendItemPattern = If(usePercentRangeStops, "{VP1:p0} - {VP2:p0}", "{V1} - {V2}")
If usePercentRangeStops Then