Back to Devexpress

ChartSheet.Chart Property

officefileapi-devexpress-dot-spreadsheet-dot-chartsheet.md

latest6.1 KB
Original Source

ChartSheet.Chart Property

Provides access to the chart on the current chart sheet.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
ChartObject Chart { get; }
vb
ReadOnly Property Chart As ChartObject

Property Value

TypeDescription
ChartObject

A ChartObject object specifying a chart on the chart sheet.

|

Remarks

Use the Chart property to get access to the chart located on the current chart sheet and specify its settings: select chart data (ChartObject.SelectData, ChartObject.Series), change the chart type (ChartObject.ChangeType), modify the chart layout (ChartObject.PlotArea, ChartObject.PrimaryAxes, ChartObject.SecondaryAxes, ChartObject.Legend, ChartObject.Title) and adjust the chart appearance (ChartObject.Style, ChartObject.Views, ChartObject.View3D).

Example

View Example

csharp
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;
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

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

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.cs#L47

csharp
// Access a chart on the chart sheet.
ChartObject chart = chartSheet.Chart;
// Select chart data.

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/CodeExamples/ChartSheetActions.cs#L47

csharp
// Access a chart on the chart sheet.
ChartObject chart = chartSheet.Chart;
// Select chart data.

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.vb#L46

vb
' Access a chart on the chart sheet.
Dim chart As ChartObject = chartSheet.Chart
' Select chart data.

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/CodeExamples/ChartSheetActions.vb#L45

vb
' Access a chart on the chart sheet.
Dim chart As ChartObject = chartSheet.Chart
' Select chart data.

See Also

ChartSheet Interface

ChartSheet Members

DevExpress.Spreadsheet Namespace