ComboChart Class

Namespace:: GemBox.Spreadsheet.Charts

Assembly:: GemBox.Spreadsheet.dll

Represents a chart that combines different chart types in a single chart.

C#
VB.NET

public sealed class ComboChart : ExcelChart, IEnumerable<ExcelChart>, IEnumerable

Public NotInheritable Class ComboChart
    Inherits ExcelChart
    Implements IEnumerable(Of ExcelChart), IEnumerable

Inheritance:: System.Object
ExcelDrawing
ExcelChart
ComboChart

Implements

System.Collections.Generic.IEnumerable<ExcelChart>

System.Collections.IEnumerable

Properties

ChartType

Gets the chart type for ComboChart which is Combo.

C#
VB.NET

public override ChartType ChartType { get; }

Public Overrides ReadOnly Property ChartType As ChartType

Property Value

ChartType

The Combo value.

Overrides

ExcelChart.ChartType

Count

Gets the number of child charts contained in the ComboChart.

C#
VB.NET

public int Count { get; }

Public ReadOnly Property Count As Integer

Property Value

System.Int32

The number of child charts contained in the ComboChart.

Item[Int32]

Gets the child chart at the specified index.

C#
VB.NET

public ExcelChart this[int index] { get; }

Public ReadOnly Property Item(index As Integer) As ExcelChart

Parameters

index: System.Int32

The zero-based index of the child chart to get.

Property Value

ExcelChart

The child chart at the specified index.

Methods

Add(ChartType)

Adds a new child chart to ComboChart.

C#
VB.NET

public ExcelChart Add(ChartType chartType)

Public Function Add(chartType As ChartType) As ExcelChart

Parameters

chartType: ChartType

Type of the child chart.

Returns

ExcelChart

A new chart added to ComboChart.

Add(ChartType, ChartGrouping)

Adds a new child chart to ComboChart.

C#
VB.NET

public ExcelChart Add(ChartType chartType, ChartGrouping chartGrouping)

Public Function Add(chartType As ChartType, chartGrouping As ChartGrouping) As ExcelChart

Parameters

chartType: ChartType

Type of the child chart.

chartGrouping: ChartGrouping

The child chart's series grouping (clustered, stacked or 100% stacked).

Returns

ExcelChart

A new chart added to ComboChart.

Add<T>()

Adds a new child chart to ComboChart.

C#
VB.NET

public T Add<T>()
    where T : ExcelChart

Public Function Add(Of T As ExcelChart) As T

Returns

T

A new chart added to ComboChart.

Type Parameters

T

The type of the chart deriving from ExcelChart type.

Add<T>(ChartGrouping)

Adds a new child chart to ComboChart.

C#
VB.NET

public T Add<T>(ChartGrouping chartGrouping)
    where T : ExcelChart

Public Function Add(Of T As ExcelChart)(chartGrouping As ChartGrouping) As T

Parameters

chartGrouping: ChartGrouping

The child chart's series grouping (clustered, stacked or 100% stacked).

Returns

T

A new chart added to ComboChart.

Type Parameters

T

The type of the chart deriving from ExcelChart type.

Contains(ExcelChart)

Determines whether the ComboChart contains the specified child chart.

C#
VB.NET

public bool Contains(ExcelChart item)

Public Function Contains(item As ExcelChart) As Boolean

Parameters

item: ExcelChart

The child chart to locate.

Returns

System.Boolean

true if child chart is found; otherwise, false.

GetEnumerator()

Returns an enumerator that iterates through child charts.

C#
VB.NET

public IEnumerator<ExcelChart> GetEnumerator()

Public Function GetEnumerator As IEnumerator(Of ExcelChart)

Returns

System.Collections.Generic.IEnumerator<ExcelChart>

An System.Collections.Generic.IEnumerator<T> that can be used to iterate through child charts.

IndexOf(ExcelChart)

Determines the index of the specified child chart.

C#
VB.NET

public int IndexOf(ExcelChart item)

Public Function IndexOf(item As ExcelChart) As Integer

Parameters

item: ExcelChart

The child chart to locate.

Returns

System.Int32

The index of child chart if found; otherwise, -1.

Remove(ExcelChart)

Removes the specified child chart from the ComboChart.

C#
VB.NET

public bool Remove(ExcelChart item)

Public Function Remove(item As ExcelChart) As Boolean

Parameters

item: ExcelChart

The child chart to remove.

Returns

System.Boolean

true if child chart was removed; otherwise, false.

RemoveAt(Int32)

Removes the child chart at the specified index.

C#
VB.NET

public void RemoveAt(int index)

Public Sub RemoveAt(index As Integer)

Parameters

index: System.Int32

The zero-based index of the child chart to remove.

Inherited Properties

CategoryLabels	Gets the chart's category labels. (Inherited from ExcelChart)
CategoryLabelsReference	Gets or sets the chart's category labels as a cell range reference (for example, 'Sheet1!A1:D1'). Values from cells in the referenced range will be used as category labels. (Inherited from ExcelChart)
DataLabels	Gets the settings for the data labels for the entire chart. (Inherited from ExcelChart)
Fill	Gets or sets the fill formatting options. (Inherited from ExcelChart)
Hyperlink	Gets or sets the hyperlink on this drawing (picture, chart, etc.). (Inherited from ExcelDrawing)
Legend	Gets the chart's legend. (Inherited from ExcelChart)
Metadata	Gets the metadata (non-visual properties) of this ExcelDrawing instance. (Inherited from ExcelDrawing)
Outline	Gets or sets the outline formatting options. (Inherited from ExcelChart)
PlotArea	Gets the chart's plot area. (Inherited from ExcelChart)
Position	Gets the position of this drawing (picture, chart, etc.) in the worksheet. (Inherited from ExcelDrawing)
RoundedCorners	Gets or sets a value indicating whether the chart area border has rounded corners. Default value is false. (Inherited from ExcelChart)
Series	Gets the chart's series. (Inherited from ExcelChart)
ShowDataInHiddenCells	Gets or sets the value which indicates whether only visible cells should be plotted on the chart. (Inherited from ExcelChart)
ShowEmptyCellsAs	Gets or sets the value which indicates how empty cells (cells with Value equal to null) shall be plotted on the chart. (Inherited from ExcelChart)
TextFormat	Gets or sets the text formatting options. (Inherited from ExcelChart)
Title	Gets the chart's title. (Inherited from ExcelChart)
UseSecondaryAxis	Gets or sets the value which indicates whether this chart should use the secondary axis of parent ComboChart. (Inherited from ExcelChart)
Worksheet	Gets the parent worksheet. (Inherited from ExcelDrawing)
ZIndex	Gets the z-order position of the picture. -1 if the picture is not contained in proper collection. (Inherited from ExcelDrawing)

Inherited Methods

BringForward()	Moves the chart one position forward in the drawings if the parent collection is ExcelChartCollection. (Inherited from ExcelChart)
BringToFront()	Brings the chart to the front of the drawings if the parent collection is ExcelChartCollection. (Inherited from ExcelChart)
ChangeChartType(ChartType)	Changes the chart to a different type of chart. (Inherited from ExcelChart)
ChangeChartType<TChart>()	Changes the chart to a different type of chart. (Inherited from ExcelChart)
Format()	Formats this drawing (picture, chart, etc.) to its default size so it can be exported to PDF, XPS, image or be printed. (Inherited from ExcelDrawing)
Format(System.Double, System.Double, LengthUnit)	Formats this drawing (picture, chart, etc.) to specified size so it can be exported to PDF, XPS, image or be printed. (Inherited from ExcelDrawing)
MoveZIndex(System.Int32)	Moves the picture forward or backward in the drawings with the given relative index if the parent collection is ExcelChartCollection. (Inherited from ExcelChart)
RefreshCache()	Refreshes cached axis, series values, and labels used by this ExcelChart instance. (Inherited from ExcelChart)
SelectData(CellRange)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(CellRange, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(CellRange, System.Boolean, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(CellRange, System.Boolean, System.Boolean, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(System.String)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(System.String, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(System.String, System.Boolean, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SelectData(System.String, System.Boolean, System.Boolean, System.Boolean)	Selects the data for the chart. (Inherited from ExcelChart)
SendBackward()	Moves the chart one position backward in the drawings if the parent collection is ExcelChartCollection. (Inherited from ExcelChart)
SendToBack()	Sends the chart to the back of the drawings if the parent collection is ExcelChartCollection. (Inherited from ExcelChart)
SetCategoryLabels(System.Collections.Generic.IEnumerable<System.String>)	Sets the chart's category labels. (Inherited from ExcelChart)
SetCategoryLabels(System.String[])	Sets the chart's category labels. (Inherited from ExcelChart)
ToString()	Returns a System.String that represents this ExcelChart instance. (Inherited from ExcelChart)

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable