PlotArea

PlotArea class

Encapsulates the object that represents the plot area in a chart.

class PlotArea extends ChartFrame;

Constructors

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

Methods

Method	Description
getX()	Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.
setX(number)	Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.
getY()	Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.
setY(number)	Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.
getHeight()	Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
setHeight(number)	Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
getWidth()	Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.
setWidth(number)	Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.
getInnerX()	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
setInnerX(number)	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
getInnerY()	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
setInnerY(number)	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
getInnerHeight()	Gets or sets the height of plot area in units of 1/4000 of the chart area.
setInnerHeight(number)	Gets or sets the height of plot area in units of 1/4000 of the chart area.
getInnerWidth()	Gets or sets the width of plot area in units of 1/4000 of the chart area.
setInnerWidth(number)	Gets or sets the width of plot area in units of 1/4000 of the chart area.
getXRatioToChart()	Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of ratio of the chart area.
setXRatioToChart(number)	Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of ratio of the chart area.
getYRatioToChart()	Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of ratio of the chart area.
setYRatioToChart(number)	Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of ratio of the chart area.
getHeightRatioToChart()	Gets or sets the height of plot-area bounding box in units of ratio of the chart area.
setHeightRatioToChart(number)	Gets or sets the height of plot-area bounding box in units of ratio of the chart area.
getWidthRatioToChart()	Gets or sets the width of plot-area bounding box in units of ratio of the chart area.
setWidthRatioToChart(number)	Gets or sets the width of plot-area bounding box in units of ratio of the chart area.
getInnerXRatioToChart()	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setInnerXRatioToChart(number)	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
getInnerYRatioToChart()	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setInnerYRatioToChart(number)	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
getInnerHeightRatioToChart()	Gets or sets the height of plot area in units of ratio of the chart area.
setInnerHeightRatioToChart(number)	Gets or sets the height of plot area in units of ratio of the chart area.
getInnerWidthRatioToChart()	Gets or sets the width of plot area in units of ratio of the chart area.
setInnerWidthRatioToChart(number)	Gets or sets the width of plot area in units of ratio of the chart area.
isAutomaticSize()	Indicates whether the plot area is automatic sized.
setIsAutomaticSize(boolean)	Indicates whether the plot area is automatic sized.
setPositionAuto()	Set position of the plot area to automatic
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 in units of 1/4000 of the chart area.
getDefaultY()	Represents y of default position in units of 1/4000 of the chart area.
getDefaultWidth()	Represents width of default position in units of 1/4000 of the chart area.
getDefaultHeight()	Represents height of default position in units of 1/4000 of the chart area.
getDefaultXRatioToChart()	Represents x of default position in units of Fraction of the chart area.
getDefaultYRatioToChart()	Represents y of default position in units of Fraction of the chart area.
getDefaultWidthRatioToChart()	Represents width of default position in units of Fraction of the chart area.
getDefaultHeightRatioToChart()	Represents height of default position in units of Fraction of the chart area.
getBorder()	Gets the border.
getArea()	Gets the area.
getTextOptions()	Gets and sets the options of the text.
getFont()	Gets a Font object of the specified ChartFrame object.
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.
getXPixel()	Gets or sets the x coordinate of the upper left corner in units of Pixel.
setXPixel(number)	Gets or sets the x coordinate of the upper left corner in units of Pixel.
getYPixel()	Gets or sets the y coordinate of the upper left corner in units of Pixel.
setYPixel(number)	Gets or sets the y coordinate of the upper left corner in units of Pixel.
getWidthPixel()	Gets or sets the width of frame in units of Pixel.
setWidthPixel(number)	Gets or sets the width of frame in units of Pixel.
getHeightPixel()	Gets or sets the height of frame in units of Pixel.
setHeightPixel(number)	Gets or sets the height of frame in units of Pixel.

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 x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.

getX() : number;

Remarks

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and InnerHeightRatioToChart properties.

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setX(number)

Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.

setX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getY()

Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.

getY() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setY(number)

Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.

setY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getHeight()

Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.

getHeight() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setHeight(number)

Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.

setHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getWidth()

Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.

getWidth() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setWidth(number)

Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getInnerX()

Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

getInnerX() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setInnerX(number)

Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

setInnerX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getInnerY()

Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

getInnerY() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setInnerY(number)

Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

setInnerY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getInnerHeight()

Gets or sets the height of plot area in units of 1/4000 of the chart area.

getInnerHeight() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setInnerHeight(number)

Gets or sets the height of plot area in units of 1/4000 of the chart area.

setInnerHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getInnerWidth()

Gets or sets the width of plot area in units of 1/4000 of the chart area.

getInnerWidth() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

setInnerWidth(number)

Gets or sets the width of plot area in units of 1/4000 of the chart area.

setInnerWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

getXRatioToChart()

Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of ratio of the chart area.

getXRatioToChart() : number;

Remarks

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and InnerHeightRatioToChart properties.

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

XPixel = XRatioToChart * chart.ChartObject.Width.

setXRatioToChart(number)

Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of ratio of the chart area.

setXRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

XPixel = XRatioToChart * chart.ChartObject.Width.

getYRatioToChart()

Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of ratio of the chart area.

getYRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

YPixel = YRatioToChart * chart.ChartObject.Width.

setYRatioToChart(number)

Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of ratio of the chart area.

setYRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

YPixel = YRatioToChart * chart.ChartObject.Width.

getHeightRatioToChart()

Gets or sets the height of plot-area bounding box in units of ratio of the chart area.

getHeightRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

HeightPixel = HeightRatioToChart * chart.ChartObject.Width.

setHeightRatioToChart(number)

Gets or sets the height of plot-area bounding box in units of ratio of the chart area.

setHeightRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

HeightPixel = HeightRatioToChart * chart.ChartObject.Width.

getWidthRatioToChart()

Gets or sets the width of plot-area bounding box in units of ratio of the chart area.

getWidthRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

WidthPixel = WidthRatioToChart * chart.ChartObject.Width.

setWidthRatioToChart(number)

Gets or sets the width of plot-area bounding box in units of ratio of the chart area.

setWidthRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

WidthPixel = WidthRatioToChart * chart.ChartObject.Width.

getInnerXRatioToChart()

Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.

getInnerXRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerX in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

setInnerXRatioToChart(number)

Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.

setInnerXRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerX in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

getInnerYRatioToChart()

Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.

getInnerYRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerY in Pixel = InnerYRatioToChart * chart.ChartObject.Width.

setInnerYRatioToChart(number)

Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.

setInnerYRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerY in Pixel = InnerYRatioToChart * chart.ChartObject.Width.

getInnerHeightRatioToChart()

Gets or sets the height of plot area in units of ratio of the chart area.

getInnerHeightRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerHeight in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

setInnerHeightRatioToChart(number)

Gets or sets the height of plot area in units of ratio of the chart area.

setInnerHeightRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerHeight in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

getInnerWidthRatioToChart()

Gets or sets the width of plot area in units of ratio of the chart area.

getInnerWidthRatioToChart() : number;

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerWidth in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

setInnerWidthRatioToChart(number)

Gets or sets the width of plot area in units of ratio of the chart area.

setInnerWidthRatioToChart(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

InnerWidth in Pixel = InnerXRatioToChart * chart.ChartObject.Width.

isAutomaticSize()

Indicates whether the plot area is automatic sized.

isAutomaticSize() : boolean;

setIsAutomaticSize(boolean)

Indicates whether the plot area is automatic sized.

setIsAutomaticSize(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

setPositionAuto()

Set position of the plot area to automatic

setPositionAuto() : void;

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 in units of 1/4000 of the chart area.

getDefaultX() : number;

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.DefaultXRatioToChart property, instead. DefaultX = (int)(DefaultXRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

getDefaultY()

Represents y of default position in units of 1/4000 of the chart area.

getDefaultY() : number;

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.DefaultYRatioToChart property, instead. DefaultY = (int)(DefaultYRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

getDefaultWidth()

Represents width of default position in units of 1/4000 of the chart area.

getDefaultWidth() : number;

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.DefaultWidthRatioToChart property, instead. DefaultWidth = (int)(DefaultWidthRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

getDefaultHeight()

Represents height of default position in units of 1/4000 of the chart area.

getDefaultHeight() : number;

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.DefaultHeightRatioToChart property, instead. DefaultHeight = (int)(DefaultHeightRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

getDefaultXRatioToChart()

Represents x of default position in units of Fraction of the chart area.

getDefaultXRatioToChart() : number;

getDefaultYRatioToChart()

Represents y of default position in units of Fraction of the chart area.

getDefaultYRatioToChart() : number;

getDefaultWidthRatioToChart()

Represents width of default position in units of Fraction of the chart area.

getDefaultWidthRatioToChart() : number;

getDefaultHeightRatioToChart()

Represents height of default position in units of Fraction of the chart area.

getDefaultHeightRatioToChart() : number;

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

getFont()

Gets a Font object of the specified ChartFrame object.

getFont() : Font;

Returns

Font

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.

getXPixel()

Gets or sets the x coordinate of the upper left corner in units of Pixel.

getXPixel() : number;

setXPixel(number)

Gets or sets the x coordinate of the upper left corner in units of Pixel.

setXPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getYPixel()

Gets or sets the y coordinate of the upper left corner in units of Pixel.

getYPixel() : number;

setYPixel(number)

Gets or sets the y coordinate of the upper left corner in units of Pixel.

setYPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWidthPixel()

Gets or sets the width of frame in units of Pixel.

getWidthPixel() : number;

setWidthPixel(number)

Gets or sets the width of frame in units of Pixel.

setWidthPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeightPixel()

Gets or sets the height of frame in units of Pixel.

getHeightPixel() : number;

setHeightPixel(number)

Gets or sets the height of frame in units of Pixel.

setHeightPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.