chart.md

Chart

Represents a chart object in a workbook.

Properties

Property	Type	Description
height	double	Represents the height, in points, of the chart object.
left	double	The distance, in points, from the left side of the chart to the worksheet origin.
name	string	Represents the name of a chart object.
top	double	Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
width	double	Represents the width, in points, of the chart object.

Relationships

Relationship	Type	Description
axes	ChartAxes	Represents chart axes. Read-only.
dataLabels	ChartDataLabels	Represents the datalabels on the chart. Read-only.
format	ChartAreaFormat	Encapsulates the format properties for the chart area. Read-only.
legend	ChartLegend	Represents the legend for the chart. Read-only.
series	ChartSeriesCollection	Represents either a single series or collection of series in the chart. Read-only.
title	ChartTitle	Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.

Methods

Method	Return Type	Description
delete()	void	Deletes the chart object.
load(param: object)	void	Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.
setData(sourceData: string, seriesBy: string)	void	Resets the source data for the chart.
setPosition(startCell: object, endCell: object)	void	Positions the chart relative to cells on the worksheet.

API Specification

delete()

Deletes the chart object.

Syntax

chartObject.delete();

Parameters

None

Returns

void

Examples

var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");	

chart.delete();
ctx.executeAsync().then(function () {
		Console.log"Chart Deleted");
});

Back

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter	Type	Description
param	object	Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void

Examples

Back

setData(sourceData: string, seriesBy: string)

Resets the source data for the chart.

Syntax

chartObject.setData(sourceData, seriesBy);

Parameters

Parameter	Type	Description
sourceData	string	The address or name of the range that contains the source data. If an address or a worksheet-scoped name is used, it must include the worksheet name (e.g. "Sheet1!A5:B9").
seriesBy	string	Optional. Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. Possible values are: Auto, Columns, Rows

Returns

void

Examples

Set the sourceData to be "A1:B4" and seriesBy to be "Columns"

var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");	
var sourceData = "A1:B4";

chart.setData(sourceData, "Columns");
ctx.executeAsync();

Back

setPosition(startCell: object, endCell: object)

Positions the chart relative to cells on the worksheet.

Syntax

chartObject.setPosition(startCell, endCell);

Parameters

Parameter	Type	Description
startCell	object	The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.
endCell	object	Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.

Returns

void

Examples

var sheetName = "Charts";
var sourceData = sheetName + "!" + "A1:B4";
var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem(sheetName).charts.add("pie", sourceData, "auto");
chart.width = 500;
chart.height = 300;
chart.setPosition("C2", null);
ctx.executeAsync();

Back

Getter and Setter Examples

Get a chart named "Chart1"

var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");	
ctx.load(chart);
ctx.executeAsync().then(function () {
		Console.log("Chart1 Loaded");
});

Update a chart including renaming, positioning and resizing.

var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");	
chart.name="New Name";
chart.top = 100;
chart.left = 100;
chart.height = 200;
chart.weight = 200;
ctx.executeAsync();

Rename the chart to new name, resize the chart to 200 points in both height and weight. Move Chart1 to 100 points to the top and left.

var ctx = new Excel.RequestContext();
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");

chart.name="New Name";	
chart.top = 100;
chart.left = 100;
chart.height =200;
chart.width =200;
ctx.executeAsync();

Back