CrosshairAxisLabelOptions.Pattern Property

Gets or sets a string which represents the pattern specifying the text to be displayed within the crosshair axis label that appears for a series point.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v19.1.dll

Declaration

C#

public string Pattern { get; set; }

VB.NET

Public Property Pattern As String

Property Value

Type	Description
String	A String that is the crosshair axis label pattern. The default value is Empty.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Pattern
ArgumentAxis3D	.CrosshairAxisLabelOptions.Pattern
Axis2D	.CrosshairAxisLabelOptions.Pattern
Axis3DBase	.CrosshairAxisLabelOptions.Pattern
AxisX2D	.CrosshairAxisLabelOptions.Pattern
AxisY2D	.CrosshairAxisLabelOptions.Pattern
SecondaryAxisX2D	.CrosshairAxisLabelOptions.Pattern
SecondaryAxisY2D	.CrosshairAxisLabelOptions.Pattern
XAxis3D	.CrosshairAxisLabelOptions.Pattern
YAxis3D	.CrosshairAxisLabelOptions.Pattern
ZAxis3D	.CrosshairAxisLabelOptions.Pattern

Remarks

You can use either the {A} pattern for the X-axis, or the {V} pattern for the Y-axis, together with the format specifiers.

For example, the table below shows {V:F0} and {V:F4} patterns that are used to format crosshair value labels.

Pattern= {V:F0}	Pattern= {V:F4}

The table below demonstrates the {A:F0} and {A:F4} patterns that format crosshair argument labels.

Pattern= {A:F0}	Pattern= {A:F4}

Note

When you format crosshair axis labels, they can demand more space on a diagram to display the whole axis value. To extend the space for a crosshair axis label, the AxisLabel.BeginText property should contain empty spaces that correspond the required area for the crosshair axis labels.

You can use standard and custom format specifics, together with the placeholders to format numeric and date/time values (e.g., {V:F0}). To learn more, see the Format Specifiers topic.

For more information on how to use a crosshair cursor, refer to the Tooltip and Crosshair Cursor topic.

Example

This example demonstrates changing a text displayed in crosshair labels using crosshair format patterns.

To accomplish this, it is necessary to specify a string which will represent a displayed pattern within a crosshair label using the CrosshairAxisLabelOptions.Pattern, XYSeries2D.CrosshairLabelPattern, and CrosshairOptions.GroupHeaderPattern properties.

In addition, standard and custom format specifiers are used together with the placeholders to format numeric and date/time values (e.g., {A:F0}). To learn more, see the Format Specifiers topic.

To learn more on a crosshair cursor, see the Tooltip and Crosshair Cursor topic.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-format-values-in-a-crosshair-cursor-via-a-labels-patterns-e4478.

MainWindow.xaml

<Window x:Class="UsingCrosshairLabelPattern.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/charts"
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <dxc:ChartControl>
            <!--region #GroupHeaderPattern-->
            <dxc:ChartControl.CrosshairOptions>
                <dxc:CrosshairOptions  GroupHeaderPattern="Year: {A}" 
                                       ShowArgumentLabels="True" ShowArgumentLine="True" 
                                       ShowValueLabels="True" ShowValueLine="True">
                </dxc:CrosshairOptions>
            </dxc:ChartControl.CrosshairOptions>
            <!--endregion #GroupHeaderPattern-->
            <dxc:ChartControl.Diagram>
                <dxc:XYDiagram2D>
                    <!--region #CrosshairAxisLabelPattern-->
                    <dxc:XYDiagram2D.AxisX>
                        <dxc:AxisX2D>
                            <dxc:AxisX2D.CrosshairAxisLabelOptions>
                                <dxc:CrosshairAxisLabelOptions Pattern="Year: {A:F0}" />
                            </dxc:AxisX2D.CrosshairAxisLabelOptions>
                        </dxc:AxisX2D>
                    </dxc:XYDiagram2D.AxisX>
                    <!--endregion #CrosshairAxisLabelPattern-->

                    <!--region #CrosshairLabelPattern-->
                    <dxc:XYDiagram2D.Series>
                        <dxc:LineSeries2D DisplayName="Europe" 
                                          CrosshairLabelPattern="{}{S} population: {V}">
                            <dxc:LineSeries2D.Points>
                                <dxc:SeriesPoint Argument="1950" Value="546" />
                                <dxc:SeriesPoint Argument="1960" Value="605" />
                                <dxc:SeriesPoint Argument="1970" Value="656" />
                                <dxc:SeriesPoint Argument="1980" Value="694" />
                                <dxc:SeriesPoint Argument="1990" Value="721" />
                                <dxc:SeriesPoint Argument="2000" Value="730" />
                                <dxc:SeriesPoint Argument="2010" Value="728" />
                                <dxc:SeriesPoint Argument="2020" Value="721" />
                                <dxc:SeriesPoint Argument="2030" Value="704" />
                                <dxc:SeriesPoint Argument="2040" Value="680" />
                                <dxc:SeriesPoint Argument="2050" Value="650" />
                            </dxc:LineSeries2D.Points>
                        </dxc:LineSeries2D>
                        <dxc:LineSeries2D  DisplayName="Americas" 
                                           CrosshairLabelPattern="{}{S} population: {V} ">
                            <dxc:LineSeries2D.Points>
                                <dxc:SeriesPoint Argument="1950" Value="332" />
                                <dxc:SeriesPoint Argument="1960" Value="417" />
                                <dxc:SeriesPoint Argument="1970" Value="513" />
                                <dxc:SeriesPoint Argument="1980" Value="614" />
                                <dxc:SeriesPoint Argument="1990" Value="721" />
                                <dxc:SeriesPoint Argument="2000" Value="836" />
                                <dxc:SeriesPoint Argument="2010" Value="935" />
                                <dxc:SeriesPoint Argument="2020" Value="1027" />
                                <dxc:SeriesPoint Argument="2030" Value="1110" />
                                <dxc:SeriesPoint Argument="2040" Value="1178" />
                                <dxc:SeriesPoint Argument="2050" Value="1231" />
                            </dxc:LineSeries2D.Points>
                        </dxc:LineSeries2D>
                    </dxc:XYDiagram2D.Series>
                    <!--endregion #CrosshairLabelPattern-->
                </dxc:XYDiagram2D>
            </dxc:ChartControl.Diagram>
        </dxc:ChartControl>
    </Grid>
</Window>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Pattern 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#

how-to-format-values-in-a-crosshair-cursor-via-a-labels-patterns-e4478/VB/UsingCrosshairLabelPattern/MainWindow.xaml#L22

<dxc:AxisX2D.CrosshairAxisLabelOptions>
    <dxc:CrosshairAxisLabelOptions Pattern="Year: {A:F0}" />
</dxc:AxisX2D.CrosshairAxisLabelOptions>

how-to-create-an-unbound-3d-chart-t454663/VB/Chart3DSample/MainWindow.xaml#L31

<dxc:YAxis3D.CrosshairAxisLabelOptions>
    <dxc:CrosshairAxisLabelOptions Pattern="{}{V:F1}" />
</dxc:YAxis3D.CrosshairAxisLabelOptions>