SeriesBase.LegendTextPattern Property
Gets or sets a string which represents the pattern specifying the text to be displayed within legend items when the SeriesViewColorEachSupportBase.ColorEach mode is enabled.
Namespace: DevExpress.XtraCharts
Assembly: DevExpress.XtraCharts.v17.2.dll
Declaration
[XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)]
[XtraSerializableProperty]
public string LegendTextPattern { get; set; }Property Value
| Type | Description |
|---|---|
| String | A String, which represents the pattern. The default value is Empty. |
Remarks
Use the LegendTextPattern property to define a pattern for a text which the legend displays. Various placeholders enclosed in braces correspond to the available display values. For example, the {A} - {V} pattern specifies text that contains series point argument and value split by a hyphen.
A full list of available placeholders is detailed below.
| Pattern | Description |
|---|---|
| {A} | Displays a series point argument. |
| {V} | Displays series point values. |
| {VP} | Displays series point values as percentages (for a Pie (Donut) series and Full-Stacked series). |
| {S} | Displays the name of the series. |
| {G} | Displays the name of a stacked group. |
| {W} | Displays the weight (for a Bubble series). |
| {V1} | Displays the first value (for range series). |
| {V2} | Displays the second value (for range series). |
| {VD} | Displays the duration between the first and second data point values (for range series). |
| {HV} | Displays the high value (for a Financial series). |
| {LV} | Displays the low value (for a Financial series). |
| {OV} | Displays the open value (for a Financial series). |
| {CV} | Displays the close value (for a Financial series). |
You can also use standard and custom format specifiers, together with the placeholders (e.g., {V:F1}).
Note
If the {VD} placeholder is used and the duration value is a date-time value, one of the following custom format specifiers can be used.
- TD - displays total days.
- TH - displays total hours.
- TM - displays total minutes.
- TS - displays total seconds.
- TMS - displays total milliseconds.
Before specifying the {S} placeholder for a series, make sure a series name is specified in the Series.Name property.
To show X-axis quarter year values on the legend, use the “{A:q}” pattern.
To learn more, refer to the Format Specifiers topic in MSDN.
The image below shows this property in action with “{S} - {A}: {V}” patterns.
In addition, you can specify a pattern using the Pattern Editor (the editor is invoked by clicking the ellipsis button of the LegendTextPattern property in the Properties window) or via the Chart Wizard.
The image below shows the Pattern Editor invoked for the LegendTextPattern property.
The editor contains numerous predefined chart placeholders together with the date-time, numeric, percent, currency, and special formats allowing you to create a text pattern.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the LegendTextPattern 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.