ChartArea

ChartArea class

Encapsulates the object that represents the chart area in the worksheet.

class ChartArea extends ChartFrame;

Example

const { Workbook, ChartType, Color } = require("aspose.cells.node");

//Instantiating a Workbook object
var workbook = new Workbook();
//Obtaining the reference of the first worksheet
var worksheet = workbook.getWorksheets().get(0);
//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.getCharts().add(ChartType.Column, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.getCharts().get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
chart.getNSeries().add("A1:B3", true);
//Getting Chart Area
var chartArea = chart.getChartArea();
//Setting the foreground color of the chart area
chartArea.getArea().setForegroundColor(Color.Yellow);
//Setting Chart Area Shadow
chartArea.setShadow(true);
//Saving the Excel file
workbook.save("output/ChartsChartArea.xls");

Constructors

Name	Description
constructor(ChartFrame)	Constructs from a parent object convertible to this.

Methods

Method	Description
getX()	Gets or gets the horizontal offset from its upper left corner column.
setX(number)	Gets or gets the horizontal offset from its upper left corner column.
getY()	Gets or gets the vertical offset from its upper left corner row.
setY(number)	Gets or gets the vertical offset from its upper left corner row.
getHeight()	Gets or sets the vertical offset from its lower right corner row.
setHeight(number)	Gets or sets the vertical offset from its lower right corner row.
getWidth()	Gets or sets the horizontal offset from its lower right corner column.
setWidth(number)	Gets or sets the horizontal offset from its lower right corner column.
getFont()	Gets a Font object of the specified chartarea object.
isNull()	Checks whether the implementation object is null.
isInnerMode()	Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
setIsInnerMode(boolean)	Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
getBackgroundMode()	Gets and sets the display mode of the background
setBackgroundMode(BackgroundMode)	Gets and sets the display mode of the background
getShadow()	True if the frame has a shadow.
setShadow(boolean)	True if the frame has a shadow.
getShapeProperties()	Gets the ShapeProperties object.
isDefaultPosBeSet()	Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
getDefaultX()	Represents x of default position
getDefaultY()	Represents y of default position
getDefaultWidth()	Represents width of default position
getDefaultHeight()	Represents height of default position
setPositionAuto()	Set position of the frame to automatic
getBorder()	Gets the border.
getArea()	Gets the area.
getTextOptions()	Gets and sets the options of the text.
getAutoScaleFont()	True if the text in the object changes font size when the object size changes. The default value is True.
setAutoScaleFont(boolean)	True if the text in the object changes font size when the object size changes. The default value is True.
isAutomaticSize()	Indicates whether the chart frame is automatic sized.
setIsAutomaticSize(boolean)	Indicates whether the chart frame is automatic sized.

constructor(ChartFrame)

Constructs from a parent object convertible to this.

constructor(obj: ChartFrame);

Parameters:

Parameter	Type	Description
obj	ChartFrame	The parent object.

getX()

Gets or gets the horizontal offset from its upper left corner column.

getX() : number;

setX(number)

Gets or gets the horizontal offset from its upper left corner column.

setX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getY()

Gets or gets the vertical offset from its upper left corner row.

getY() : number;

setY(number)

Gets or gets the vertical offset from its upper left corner row.

setY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeight()

Gets or sets the vertical offset from its lower right corner row.

getHeight() : number;

setHeight(number)

Gets or sets the vertical offset from its lower right corner row.

setHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidth()

Gets or sets the horizontal offset from its lower right corner column.

getWidth() : number;

setWidth(number)

Gets or sets the horizontal offset from its lower right corner column.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getFont()

Gets a Font object of the specified chartarea object.

getFont() : Font;

Returns

Font

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

isInnerMode()

Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.

isInnerMode() : boolean;

Remarks

Only for Xlsx file.

setIsInnerMode(boolean)

setIsInnerMode(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for Xlsx file.

getBackgroundMode()

Gets and sets the display mode of the background

getBackgroundMode() : BackgroundMode;

Returns

BackgroundMode

setBackgroundMode(BackgroundMode)

Gets and sets the display mode of the background

setBackgroundMode(value: BackgroundMode) : void;

Parameters:

Parameter	Type	Description
value	BackgroundMode	The value to set.

getShadow()

True if the frame has a shadow.

getShadow() : boolean;

setShadow(boolean)

True if the frame has a shadow.

setShadow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShapeProperties()

Gets the ShapeProperties object.

getShapeProperties() : ShapePropertyCollection;

Returns

ShapePropertyCollection

isDefaultPosBeSet()

Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

isDefaultPosBeSet() : boolean;

getDefaultX()

Represents x of default position

getDefaultX() : number;

getDefaultY()

Represents y of default position

getDefaultY() : number;

getDefaultWidth()

Represents width of default position

getDefaultWidth() : number;

getDefaultHeight()

Represents height of default position

getDefaultHeight() : number;

setPositionAuto()

Set position of the frame to automatic

setPositionAuto() : void;

getBorder()

Gets the border.

getBorder() : Line;

Returns

Line

getArea()

Gets the area.

getArea() : Area;

Returns

Area

getTextOptions()

Gets and sets the options of the text.

getTextOptions() : TextOptions;

Returns

TextOptions

getAutoScaleFont()

True if the text in the object changes font size when the object size changes. The default value is True.

getAutoScaleFont() : boolean;

setAutoScaleFont(boolean)

True if the text in the object changes font size when the object size changes. The default value is True.

setAutoScaleFont(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isAutomaticSize()

Indicates whether the chart frame is automatic sized.

isAutomaticSize() : boolean;

setIsAutomaticSize(boolean)

Indicates whether the chart frame is automatic sized.

setIsAutomaticSize(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.