XYDiagramPaneCollection.Add(XYDiagramPane) Method

Appends the specified XYDiagramPane object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

public int Add(
    XYDiagramPane pane
)

VB.NET

Public Function Add(
    pane As XYDiagramPane
) As Integer

Parameters

Name	Type	Description
pane	XYDiagramPane	An XYDiagramPane object to append to the collection.

Returns

Type	Description
Int32	An integer value indicating the position at which the new element was inserted.

Remarks

This method adds the object to the end of the collection.

For more information, refer to Panes.

Example

This example demonstrates how panes can be accessed and customized at runtime.

Assuming that there are two series of the line view type in the chart, in the following code, we create an additional pane, and assign the second series to it. In addition, a secondary axis is created and assigned to that series, and it is also visible in the additional pane.

C#

using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraCharts;
// ...

private void Form1_Load(object sender, EventArgs e) {
    // Create a new chart.
    ChartControl chartControl1 = new ChartControl();

    // Create two series.
    Series series1 = new Series("Series 1", ViewType.Bar);
    Series series2 = new Series("Series 2", ViewType.Line);

    // Add points to them, with their arguments different.
    series1.Points.Add(new SeriesPoint("A", 10));
    series1.Points.Add(new SeriesPoint("B", 12));
    series1.Points.Add(new SeriesPoint("C", 17));
    series1.Points.Add(new SeriesPoint("D", 14));
    series2.Points.Add(new SeriesPoint("I", 2500));
    series2.Points.Add(new SeriesPoint("II", 3800));
    series2.Points.Add(new SeriesPoint("III", 1500));
    series2.Points.Add(new SeriesPoint("IV", 1300));

    // Add both series to the chart.
    chartControl1.Series.AddRange(new Series[] { series1, series2 });

    // Hide the legend (optional).
    chartControl1.Legend.Visible = false;

    // Cast the chart's diagram to the XYDiagram type, 
    // to access its axes and panes.
    XYDiagram diagram = (XYDiagram)chartControl1.Diagram;

    // Add secondary axes to the diagram, and adjust their options.
    diagram.SecondaryAxesX.Add(new SecondaryAxisX("My Axis X"));
    diagram.SecondaryAxesY.Add(new SecondaryAxisY("My Axis Y"));
    diagram.SecondaryAxesX[0].Alignment = AxisAlignment.Near;
    diagram.SecondaryAxesY[0].Alignment = AxisAlignment.Near;

    // Add a new additional pane to the diagram.
    diagram.Panes.Add(new XYDiagramPane("My Pane"));

    // Assign both the additional pane and, if required,
    // the secondary axes to the second series. 
    LineSeriesView myView = (LineSeriesView)series2.View;
    myView.AxisX = diagram.SecondaryAxesX[0];
    myView.AxisY = diagram.SecondaryAxesY[0];
    // Note that the created pane has the zero index in the collection,
    // because the existing Default pane is a separate entity.
    myView.Pane = diagram.Panes[0];

    // Customize the layout of the diagram's panes.
    diagram.PaneDistance = 10;
    diagram.PaneLayoutDirection = PaneLayoutDirection.Horizontal;
    diagram.DefaultPane.SizeMode = PaneSizeMode.UseWeight;
    diagram.DefaultPane.Weight = 1.2;

    // Add the chart to the form.
    chartControl1.Dock = DockStyle.Fill;
    this.Controls.Add(chartControl1);
}

VB.NET

Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraCharts
' ...

Private Sub Form1_Load(ByVal sender As Object, _ 
ByVal e As EventArgs) Handles MyBase.Load
    ' Create a new chart.
    Dim chartControl1 As New ChartControl()

    ' Create two series.
    Dim series1 As New Series("Series 1", ViewType.Bar)
    Dim series2 As New Series("Series 2", ViewType.Line)

    ' Add points to them, with their arguments different.
    series1.Points.Add(New SeriesPoint("A", 10))
    series1.Points.Add(New SeriesPoint("B", 12))
    series1.Points.Add(New SeriesPoint("C", 17))
    series1.Points.Add(New SeriesPoint("D", 14))
    series2.Points.Add(New SeriesPoint("I", 2500))
    series2.Points.Add(New SeriesPoint("II", 3800))
    series2.Points.Add(New SeriesPoint("III", 1500))
    series2.Points.Add(New SeriesPoint("IV", 1300))

    ' Add both series to the chart.
    chartControl1.Series.AddRange(New Series() { series1, series2 })

    ' Hide the legend (optional).
    chartControl1.Legend.Visible = False

    ' Cast the chart's diagram to the XYDiagram type, 
    ' to access its axes and panes.
    Dim diagram As XYDiagram = CType(chartControl1.Diagram, XYDiagram)

    ' Add secondary axes to the diagram, and adjust their options.
    diagram.SecondaryAxesX.Add(New SecondaryAxisX("My Axis X"))
    diagram.SecondaryAxesY.Add(New SecondaryAxisY("My Axis Y"))
    diagram.SecondaryAxesX(0).Alignment = AxisAlignment.Near
    diagram.SecondaryAxesY(0).Alignment = AxisAlignment.Near

    ' Add a new additional pane to the diagram.
    diagram.Panes.Add(New XYDiagramPane("My Pane"))

    ' Assign both the additional pane and, if required,
    ' the secondary axes to the second series. 
    Dim myView As LineSeriesView = CType(series2.View, LineSeriesView)
    myView.AxisX = diagram.SecondaryAxesX(0)
    myView.AxisY = diagram.SecondaryAxesY(0)
    ' Note that the created pane has the zero index in the collection,
    ' because the existing Default pane is a separate entity.
    myView.Pane = diagram.Panes(0)

    ' Customize the layout of the diagram's panes.
    diagram.PaneDistance = 10
    diagram.PaneLayoutDirection = PaneLayoutDirection.Horizontal
    diagram.DefaultPane.SizeMode = PaneSizeMode.UseWeight
    diagram.DefaultPane.Weight = 1.2

    ' Add the chart to the form.
    chartControl1.Dock = DockStyle.Fill
    Me.Controls.Add(chartControl1)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(XYDiagramPane) method.

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-programmatically-display-automatically-created-series-in-separate-panes-e433/CS/MainForm.cs#L22

XYDiagramPane pane = new XYDiagramPane(String.Format(@"Pane {0}", i));
diagram.Panes.Add(pane);
XYDiagramSeriesViewBase view = (XYDiagramSeriesViewBase)chart.Series[i].View;

VB.NET

how-to-programmatically-display-automatically-created-series-in-separate-panes-e433/VB/MainForm.vb#L24

Dim pane As New XYDiagramPane(String.Format("Pane {0}", i))
diagram.Panes.Add(pane)
Dim view As XYDiagramSeriesViewBase = CType(chart.Series(i).View, XYDiagramSeriesViewBase)