Class
ChartCollection

Collection of chart shapes in a worksheet, providing methods to add and manage data-driven charts.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class ChartCollection : FilteredShapeCollection<FloatingChartShape>, IEnumerable

Inheritance: objectFilteredShapeCollection<FloatingChartShape>ChartCollection

Implements: IEnumerable

Inherited Members FilteredShapeCollection<FloatingChartShape>.Remove(FloatingChartShape)FilteredShapeCollection<FloatingChartShape>.Contains(FloatingChartShape)FilteredShapeCollection<FloatingChartShape>.IndexOf(FloatingChartShape)FilteredShapeCollection<FloatingChartShape>.Clear()FilteredShapeCollection<FloatingChartShape>.GetEnumerator()FilteredShapeCollection<FloatingChartShape>.GetZIndex(FloatingChartShape)FilteredShapeCollection<FloatingChartShape>.Add(FloatingChartShape)FilteredShapeCollection<FloatingChartShape>.OnItemAdding(FloatingChartShape, out ShapeCollectionChangingEventArgs<FloatingChartShape>)FilteredShapeCollection<FloatingChartShape>.OnItemRemoving(FloatingChartShape, out ShapeCollectionChangingEventArgs<FloatingChartShape>)FilteredShapeCollection<FloatingChartShape>.OnChanging(ShapeCollectionChangingEventArgs<FloatingChartShape>)FilteredShapeCollection<FloatingChartShape>.OnChanged(ShapeCollectionChangedEventArgs<FloatingChartShape>)FilteredShapeCollection<FloatingChartShape>.CountFilteredShapeCollection<FloatingChartShape>.this[int]FilteredShapeCollection<FloatingChartShape>.WorksheetFilteredShapeCollection<FloatingChartShape>.ChangingFilteredShapeCollection<FloatingChartShape>.Changed

Constructors

ChartCollection(Worksheet)

Initializes a new ChartCollection for the specified worksheet.

Declaration

cs-api-definition
public ChartCollection(Worksheet worksheet)

Parameters

worksheet

Worksheet

The worksheet.

Properties

ShapeType

Gets the shape type filtered by this collection, always returning Chart.

Declaration

cs-api-definition
public override FloatingShapeType ShapeType { get; }

Property Value

FloatingShapeType

Overrides FilteredShapeCollection<FloatingChartShape>.ShapeType

Methods

Add(CellIndex, CellRange, SeriesRangesOrientation, params ChartType[])

Creates a chart at the specified cell position based on the data range with explicit series orientation control and returns the chart shape.

Declaration

cs-api-definition
public FloatingChartShape Add(CellIndex cellIndex, CellRange chartDataRange, SeriesRangesOrientation seriesRangesOrientation, params ChartType[] chartTypes)

Parameters

cellIndex

CellIndex

The cell index where the top left corner of the shape is positioned.

chartDataRange

CellRange

The range containing the data that the chart will be based on.

seriesRangesOrientation

SeriesRangesOrientation

A value indicating whether the series of the chart will refer to vertical or horizontal ranges or the direction will be determined automatically.

chartTypes

ChartType[]

The types of chart that will be created. Passing more than one type will create a combo chart.

Returns

FloatingChartShape

The result chart shape.

Add(CellIndex, CellRange, params ChartType[])

Creates a chart at the specified cell position based on the data range, automatically determining series orientation, and returns the chart shape.

Declaration

cs-api-definition
public FloatingChartShape Add(CellIndex cellIndex, CellRange chartDataRange, params ChartType[] chartTypes)

Parameters

cellIndex

CellIndex

The cell index where the top left corner of the shape is positioned.

chartDataRange

CellRange

The range containing the data that the chart will be based on.

chartTypes

ChartType[]

The types of chart that will be created. Passing more than one type will create a combo chart.

Returns

FloatingChartShape

The result chart shape.