Chart.AlignDataPointsByAxisLabel Method (String)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Aligns data points from different series along the X axis using their axis labels. The specified series in the chart are aligned using an ascending sort order.

Namespace:   System.Windows.Forms.DataVisualization.Charting
Assembly:  System.Windows.Forms.DataVisualization (in System.Windows.Forms.DataVisualization.dll)

public void AlignDataPointsByAxisLabel(
	string series
)

Parameters

series
Type: System.String

A comma-separated list of series that will have their data points aligned to the X axis using the data point axis labels.

This method is used to align data points from different series along the X axis using their axis labels, and is applicable when:

  • Multiple series are displayed and are indexed; that is, all data points have an XValue of 0, or the IsXValueIndexed property is true.

  • All data points have non-empty axis labels, which are unique to their Series. If they are not unique, an exception will be thrown.

This situation is very common when data-binding results in the creation of multiple series, and string values are used for X-axis values.

Two issues arise when multiple, indexed series are plotted, and the X-values are set using string values:

  • It cannot be guaranteed that data points from different series with the same string X-values will be plotted at the same index along the X axis.

  • Only the axis label for the data points in the first series will be displayed, even though data points from other series with the same index have axis labels too.

By default, points are plotted in the order in which they are stored in their series. To specify a sort order, use an AlignDataPointsByAxisLabel method overload that has a sortingOrder parameter.

.NET Framework
Available since 4.0
Return to top
Show: