ChartSheetCollection.Add(ChartType) Method

Creates a new chart sheet of the specified type and appends it to the end of the collection.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

ChartSheet Add(
    ChartType chartType
)

VB.NET

Function Add(
    chartType As ChartType
) As ChartSheet

Parameters

Name	Type	Description
chartType	ChartType	A ChartType enumeration member specifying the chart type.

Returns

Type	Description
ChartSheet	A ChartSheet object that specifies the new chart sheet.

Remarks

The Add method creates a new chart sheet under the default name like ChartN, where N is a number that is greater by 1 than the maximum number used in chart sheet names of the same type. To change the chart sheet name, use the ChartSheet.Name property. Use the ChartSheet.Chart property to access a chart located on the chart sheet and specify its settings (select chart data and adjust the chart appearance).

To insert a new chart sheet to the specified position in the collection, use the ChartSheetCollection.Insert method.

To remove a chart sheet from the collection, use the ChartSheetCollection.Remove or ChartSheetCollection.RemoveAt method.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheet-chart-api-e5222

ChartSheetActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("chartTask2")

' Create an empty chart sheet of the specified type.
Dim chartSheet As ChartSheet = workbook.ChartSheets.Add(ChartType.BarFullStacked)

' Access a chart on the chart sheet.
Dim chart As ChartObject = chartSheet.Chart
' Select chart data.
chart.SelectData(worksheet("B3:C8"), ChartDataDirection.Row)

' Display the chart title.
chart.Title.Visible = True
chart.Title.SetReference(worksheet("B1"))

' Change the legend position.
chart.Legend.Position = LegendPosition.Bottom

' Hide the category axis.
chart.PrimaryAxes(0).Visible = False

' Set the value axis' major unit.
chart.PrimaryAxes(1).MajorUnit = 0.2

workbook.ChartSheets.ActiveChartSheet = chartSheet

ChartSheetActions.cs

Worksheet worksheet = workbook.Worksheets["chartTask2"];

// Create an empty chart sheet of the specified type.
ChartSheet chartSheet = workbook.ChartSheets.Add(ChartType.BarFullStacked);

// Access a chart on the chart sheet.
ChartObject chart = chartSheet.Chart;
// Select chart data.
chart.SelectData(worksheet["B3:C8"], ChartDataDirection.Row);

// Display the chart title.
chart.Title.Visible = true;
chart.Title.SetReference(worksheet["B1"]);

// Change the legend position.
chart.Legend.Position = LegendPosition.Bottom;

// Hide the category axis.
chart.PrimaryAxes[0].Visible = false;

// Set the value axis' major unit.
chart.PrimaryAxes[1].MajorUnit = 0.2;

workbook.ChartSheets.ActiveChartSheet = chartSheet;