Back to Devexpress

XYDiagramPane Class

corelibraries-devexpress-dot-xtracharts-8fcdb456.md

latest10.6 KB
Original Source

XYDiagramPane Class

Represents an XY-diagram’s additional pane.

Namespace : DevExpress.XtraCharts

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
public class XYDiagramPane :
    XYDiagramPaneBase,
    ISupportInitialize,
    IXtraSerializable,
    IHitTest,
    ISupportID
vb
Public Class XYDiagramPane
    Inherits XYDiagramPaneBase
    Implements ISupportInitialize,
               IXtraSerializable,
               IHitTest,
               ISupportID

The following members return XYDiagramPane objects:

Remarks

By default, a diagram displays a single default pane, which is represented by the XYDiagramDefaultPane class. If a diagram contains several series, it is possible to display the remaining series on additional panes represented by the XYDiagramPane class.

For more information, refer to Panes.

Example

This example shows how to plot multiple series in separate panes.

  1. Create a ChartControl object.

  2. Create two Series objects. Populate their Points collection with SeriesPoint objects. Add both series to the ChartControl.Series collection. See the Provide Data document for more information on how to create series and populate them with data.

  3. To add a pane in addition to the diagram’s DefaultPane, create a new XYDiagramPane and add it to the Panes collection. Use the XYDiagramSeriesViewBase.Pane property to assign the pane to a series view.

  4. To add a secondary x-axis, add a SecondaryAxisX object to the diagram’s SecondaryAxesX collection. To add a secondary y-axis, add a SecondaryAxisY object to the diagram’s SecondaryAxesY collection. To assign the axes to the view, use the AxisX and AxisY properties.

csharp
using System;
using System.Windows.Forms;
using DevExpress.Utils;
using DevExpress.XtraCharts;
// ...
private void OnFormLoad(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("Asia", 80));
    series1.Points.Add(new SeriesPoint("Europe", 74));
    series1.Points.Add(new SeriesPoint("Australia", 96));
    series1.Points.Add(new SeriesPoint("North America", 85));

    series2.Points.Add(new SeriesPoint(new DateTime(2018, 02, 28), 420));
    series2.Points.Add(new SeriesPoint(new DateTime(2018, 05, 31), 375));
    series2.Points.Add(new SeriesPoint(new DateTime(2018, 08, 31), 490));
    series2.Points.Add(new SeriesPoint(new DateTime(2018, 11, 30), 560));

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

    // Cast the second series's view to the LineSeriesView type.
    LineSeriesView myView = (LineSeriesView)series2.View;

    // Hide the legend (optional).
    chartControl1.Legend.Visibility = DefaultBoolean.False;

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

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

    // 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];

    // Add titles to panes.
    diagram.DefaultPane.Title.Text = "Sales by Region (Units)";
    diagram.DefaultPane.Title.Visibility = DefaultBoolean.True;
    diagram.Panes[0].Title.Text = "Revenue (Millions of USD)";
    diagram.Panes[0].Title.Visibility = DefaultBoolean.True;

    // Customize the pane layout.
    diagram.PaneDistance = 10;
    diagram.PaneLayout.AutoLayoutMode = PaneAutoLayoutMode.Linear;
    diagram.PaneLayout.Direction = PaneLayoutDirection.Horizontal;
    diagram.DefaultPane.LayoutOptions.ColumnSpan = 3;
    diagram.Panes[0].LayoutOptions.ColumnSpan = 2;

    // 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;
    diagram.SecondaryAxesY[0].GridLines.Visible = true;

    // Assign both the additional pane and, if required,
    // the secondary axes to the second series.             
    myView.AxisX = diagram.SecondaryAxesX[0];
    myView.AxisY = diagram.SecondaryAxesY[0];

    // Add the chart to the form.
    chartControl1.Dock = DockStyle.Fill;
    this.Controls.Add(chartControl1);
}
vb
Imports DevExpress.Utils
Imports DevExpress.XtraCharts
Imports System
Imports System.Windows.Forms
' ...
Private Sub OnFormLoad(ByVal sender As Object, ByVal e As EventArgs) Handles Me.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("Asia", 80))
    series1.Points.Add(New SeriesPoint("Europe", 74))
    series1.Points.Add(New SeriesPoint("Australia", 96))
    series1.Points.Add(New SeriesPoint("North America", 85))

    series2.Points.Add(New SeriesPoint(New Date(2018, 02, 28), 420))
    series2.Points.Add(New SeriesPoint(New Date(2018, 05, 31), 375))
    series2.Points.Add(New SeriesPoint(New Date(2018, 08, 31), 490))
    series2.Points.Add(New SeriesPoint(New Date(2018, 11, 30), 560))

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

    ' Cast the second series's view to the LineSeriesView type.
    Dim myView As LineSeriesView = CType(series2.View, LineSeriesView)

    ' Hide the legend (optional).
    chartControl1.Legend.Visibility = DefaultBoolean.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 a new additional pane to the diagram.
    diagram.Panes.Add(New XYDiagramPane("My Pane"))

    ' 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)

    ' Add titles to panes.
    diagram.DefaultPane.Title.Text = "Sales by Region (Units)"
    diagram.DefaultPane.Title.Visibility = DefaultBoolean.True
    diagram.Panes(0).Title.Text = "Revenue (Millions of USD)"
    diagram.Panes(0).Title.Visibility = DefaultBoolean.True

    ' Customize the pane layout.
    diagram.PaneDistance = 10
    diagram.PaneLayout.AutoLayoutMode = PaneAutoLayoutMode.Linear
    diagram.PaneLayout.Direction = PaneLayoutDirection.Horizontal
    diagram.DefaultPane.LayoutOptions.ColumnSpan = 3
    diagram.Panes(0).LayoutOptions.ColumnSpan = 2

    ' 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
    diagram.SecondaryAxesY(0).GridLines.Visible = True

    ' Assign both the additional pane and, if required,
    ' the secondary axes to the second series.             
    myView.AxisX = diagram.SecondaryAxesX(0)
    myView.AxisY = diagram.SecondaryAxesY(0)

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

Implements

IDockTarget

IXtraSerializable

Inheritance

Object ChartElement ChartElementNamed XYDiagramPaneBase XYDiagramPane

See Also

XYDiagramPane Members

Panes

How to: Create a Multi-Pane Chart

DevExpress.XtraCharts Namespace