Back to Devexpress

HeatmapPaletteColorProvider.LegendItemPattern Property

wpf-devexpress-dot-xpf-dot-charts-dot-heatmap-dot-heatmappalettecolorprovider.md

latest2.4 KB
Original Source

HeatmapPaletteColorProvider.LegendItemPattern Property

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

Namespace : DevExpress.Xpf.Charts.Heatmap

Assembly : DevExpress.Xpf.Charts.v25.2.dll

NuGet Package : DevExpress.Wpf.Charts

Declaration

csharp
public string LegendItemPattern { get; set; }
vb
Public Property LegendItemPattern As String

Property Value

TypeDescription
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:

PlaceholderDescription
{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:

PlaceholderDescription
{V}Displays a key value.

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

xaml
<dxh:HeatmapRangeColorProvider LegendItemPattern="{}{VP1:0%} - {VP2:0%}"/>

See Also

HeatmapPaletteColorProvider Class

HeatmapPaletteColorProvider Members

DevExpress.Xpf.Charts.Heatmap Namespace