Interface IChart

Top-level interface that represents Excel chart

Namespace: IronXL.Drawing.Charts
Assembly: IronXL.dll
Syntax
public interface IChart

IChart is the chart a worksheet builds from its cell data, ready to title, populate with series, and draw onto the sheet. A developer works through this contract to turn a range of values into a column, line, or pie chart embedded in the spreadsheet, the same visual Excel produces from the Insert Chart menu. It represents one chart anchored to a worksheet, and its members configure that chart before it is rendered.

A developer obtains an IChart from the worksheet rather than constructing one: WorkSheet.CreateChart returns a new chart for a chosen ChartType and cell-range bounds, and WorkSheet.Charts (a List<IChart>) holds every chart already on the sheet. AddSeries(string values) and AddSeries(string xRange, string yRange) attach the data, each returning an IChartSeries for further configuration. SetTitle(string title) names the chart, SetLegendPosition(LegendPosition position) places the legend, and Position reports where the chart is anchored. Once the series and labels are set, Plot() draws the chart onto the worksheet, and saving the workbook persists it.

IChart chart = sheet.CreateChart(ChartType.Line, 5, 5, 20, 10);
chart.AddSeries("A1:A10");
chart.SetTitle("Revenue");
chart.Plot();

The create a line chart example builds a chart from cell data, and the create a chart programmatically how-to walks through the full setup.

Properties

Position

Gets the position of the chart

Declaration
Position Position { get; }
Property Value
Type Description
Position

Methods

AddSeries(String)

Adds the series to the chart.

Declaration
IChartSeries AddSeries(string values)
Parameters
Type Name Description
System.String values

Address of the values range.
Returns
Type Description
IChartSeries

Created chart series.

AddSeries(String, String)

Adds the series to the chart.

Declaration
IChartSeries AddSeries(string xRange, string yRange)
Parameters
Type Name Description
System.String xRange

Address of the range for horizontal axis.
System.String yRange

Address of the range for vertical axis.
Returns
Type Description
IChartSeries

Created chart series.

Plot()

Plots all the data that was added to the chart before.

The behavior of this method is similar to commiting all new series changes to the chart.

Declaration
void Plot()

SetLegendPosition(LegendPosition)

Sets the legend position. Setting None removes the legend.

Declaration
void SetLegendPosition(LegendPosition position)
Parameters
Type Name Description
LegendPosition position

SetTitle(String)

Sets the title of the series.

Declaration
void SetTitle(string title)
Parameters
Type Name Description
System.String title

the title of the chart