PlotArea

PlotArea class

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

class PlotArea extends ChartFrame;

Constructors

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

Properties

Property	Type	Description
innerX	number	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
innerY	number	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
innerHeight	number	Gets or sets the height of plot area in units of 1/4000 of the chart area.
innerWidth	number	Gets or sets the width of plot area in units of 1/4000 of the chart area.
innerXRatioToChart	number	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
innerYRatioToChart	number	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
innerHeightRatioToChart	number	Gets or sets the height of plot area in units of ratio of the chart area.
innerWidthRatioToChart	number	Gets or sets the width of plot area in units of ratio of the chart area.
isInnerMode	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.
backgroundMode	BackgroundMode	Gets and sets the display mode of the background
shadow	boolean	True if the frame has a shadow.
shapeProperties	ShapePropertyCollection	Readonly. Gets the ShapeProperties object.
isDefaultPosBeSet	boolean	Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
defaultX	number	Readonly. Represents x of default position in units of 1/4000 of the chart area.
defaultY	number	Readonly. Represents y of default position in units of 1/4000 of the chart area.
defaultWidth	number	Readonly. Represents width of default position in units of 1/4000 of the chart area.
defaultHeight	number	Readonly. Represents height of default position in units of 1/4000 of the chart area.
defaultXRatioToChart	number	Readonly. Represents x of default position in units of Fraction of the chart area.
defaultYRatioToChart	number	Readonly. Represents y of default position in units of Fraction of the chart area.
defaultWidthRatioToChart	number	Readonly. Represents width of default position in units of Fraction of the chart area.
defaultHeightRatioToChart	number	Readonly. Represents height of default position in units of Fraction of the chart area.

Methods

Method	Description
getInnerX()	@deprecated. Please use the ‘innerX’ property instead. 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)	@deprecated. Please use the ‘innerX’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
getInnerY()	@deprecated. Please use the ‘innerY’ property instead. 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)	@deprecated. Please use the ‘innerY’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
getInnerHeight()	@deprecated. Please use the ‘innerHeight’ property instead. Gets or sets the height of plot area in units of 1/4000 of the chart area.
setInnerHeight(number)	@deprecated. Please use the ‘innerHeight’ property instead. Gets or sets the height of plot area in units of 1/4000 of the chart area.
getInnerWidth()	@deprecated. Please use the ‘innerWidth’ property instead. Gets or sets the width of plot area in units of 1/4000 of the chart area.
setInnerWidth(number)	@deprecated. Please use the ‘innerWidth’ property instead. Gets or sets the width of plot area in units of 1/4000 of the chart area.
getInnerXRatioToChart()	@deprecated. Please use the ‘innerXRatioToChart’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setInnerXRatioToChart(number)	@deprecated. Please use the ‘innerXRatioToChart’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
getInnerYRatioToChart()	@deprecated. Please use the ‘innerYRatioToChart’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setInnerYRatioToChart(number)	@deprecated. Please use the ‘innerYRatioToChart’ property instead. Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
getInnerHeightRatioToChart()	@deprecated. Please use the ‘innerHeightRatioToChart’ property instead. Gets or sets the height of plot area in units of ratio of the chart area.
setInnerHeightRatioToChart(number)	@deprecated. Please use the ‘innerHeightRatioToChart’ property instead. Gets or sets the height of plot area in units of ratio of the chart area.
getInnerWidthRatioToChart()	@deprecated. Please use the ‘innerWidthRatioToChart’ property instead. Gets or sets the width of plot area in units of ratio of the chart area.
setInnerWidthRatioToChart(number)	@deprecated. Please use the ‘innerWidthRatioToChart’ property instead. Gets or sets the width of plot area in units of ratio of the chart area.
isNull()	Checks whether the implementation object is null.
isInnerMode()	@deprecated. Please use the ‘isInnerMode’ property instead. 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)	@deprecated. Please use the ‘isInnerMode’ property instead. 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()	@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
setBackgroundMode(BackgroundMode)	@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
getShadow()	@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.
setShadow(boolean)	@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.
getShapeProperties()	@deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapeProperties object.
isDefaultPosBeSet()	@deprecated. Please use the ‘isDefaultPosBeSet’ property instead. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
getDefaultX()	@deprecated. Please use the ‘defaultX’ property instead. Represents x of default position in units of 1/4000 of the chart area.
getDefaultY()	@deprecated. Please use the ‘defaultY’ property instead. Represents y of default position in units of 1/4000 of the chart area.
getDefaultWidth()	@deprecated. Please use the ‘defaultWidth’ property instead. Represents width of default position in units of 1/4000 of the chart area.
getDefaultHeight()	@deprecated. Please use the ‘defaultHeight’ property instead. Represents height of default position in units of 1/4000 of the chart area.
getDefaultXRatioToChart()	@deprecated. Please use the ‘defaultXRatioToChart’ property instead. Represents x of default position in units of Fraction of the chart area.
getDefaultYRatioToChart()	@deprecated. Please use the ‘defaultYRatioToChart’ property instead. Represents y of default position in units of Fraction of the chart area.
getDefaultWidthRatioToChart()	@deprecated. Please use the ‘defaultWidthRatioToChart’ property instead. Represents width of default position in units of Fraction of the chart area.
getDefaultHeightRatioToChart()	@deprecated. Please use the ‘defaultHeightRatioToChart’ property instead. Represents height of default position in units of Fraction of the chart area.
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.
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.
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
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.

innerX

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

innerX : 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().

innerY

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

innerY : number;

Remarks

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

innerHeight

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

innerHeight : number;

Remarks

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

innerWidth

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

innerWidth : number;

Remarks

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

innerXRatioToChart

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

innerXRatioToChart : 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().

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

innerYRatioToChart

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

innerYRatioToChart : 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.

innerHeightRatioToChart

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

innerHeightRatioToChart : 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.

innerWidthRatioToChart

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

innerWidthRatioToChart : 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.

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.

backgroundMode

Gets and sets the display mode of the background

backgroundMode : BackgroundMode;

shadow

True if the frame has a shadow.

shadow : boolean;

shapeProperties

Readonly. Gets the ShapeProperties object.

shapeProperties : ShapePropertyCollection;

isDefaultPosBeSet

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

isDefaultPosBeSet : boolean;

defaultX

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

defaultX : 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.

defaultY

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

defaultY : 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.

defaultWidth

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

defaultWidth : 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.

defaultHeight

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

defaultHeight : 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.

defaultXRatioToChart

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

defaultXRatioToChart : number;

defaultYRatioToChart

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

defaultYRatioToChart : number;

defaultWidthRatioToChart

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

defaultWidthRatioToChart : number;

defaultHeightRatioToChart

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

defaultHeightRatioToChart : number;

getInnerX()

@deprecated. Please use the ‘innerX’ property instead. 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)

@deprecated. Please use the ‘innerX’ property instead. 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()

@deprecated. Please use the ‘innerY’ property instead. 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)

@deprecated. Please use the ‘innerY’ property instead. 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()

@deprecated. Please use the ‘innerHeight’ property instead. 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)

@deprecated. Please use the ‘innerHeight’ property instead. 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()

@deprecated. Please use the ‘innerWidth’ property instead. 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)

@deprecated. Please use the ‘innerWidth’ property instead. 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().

getInnerXRatioToChart()

@deprecated. Please use the ‘innerXRatioToChart’ property instead. 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)

@deprecated. Please use the ‘innerXRatioToChart’ property instead. 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()

@deprecated. Please use the ‘innerYRatioToChart’ property instead. 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)

@deprecated. Please use the ‘innerYRatioToChart’ property instead. 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()

@deprecated. Please use the ‘innerHeightRatioToChart’ property instead. 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)

@deprecated. Please use the ‘innerHeightRatioToChart’ property instead. 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()

@deprecated. Please use the ‘innerWidthRatioToChart’ property instead. 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)

@deprecated. Please use the ‘innerWidthRatioToChart’ property instead. 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.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

isInnerMode()

@deprecated. Please use the ‘isInnerMode’ property instead. 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()

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

getBackgroundMode() : BackgroundMode;

Returns

BackgroundMode

setBackgroundMode(BackgroundMode)

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

setBackgroundMode(value: BackgroundMode) : void;

Parameters:

Parameter	Type	Description
value	BackgroundMode	The value to set.

getShadow()

@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.

getShadow() : boolean;

setShadow(boolean)

@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.

setShadow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShapeProperties()

@deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapeProperties object.

getShapeProperties() : ShapePropertyCollection;

Returns

ShapePropertyCollection

isDefaultPosBeSet()

@deprecated. Please use the ‘isDefaultPosBeSet’ property instead. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

isDefaultPosBeSet() : boolean;

getDefaultX()

@deprecated. Please use the ‘defaultX’ property instead. Represents x of default position in units of 1/4000 of the chart area.

getDefaultX() : number;

Remarks

getDefaultY()

@deprecated. Please use the ‘defaultY’ property instead. Represents y of default position in units of 1/4000 of the chart area.

getDefaultY() : number;

Remarks

getDefaultWidth()

@deprecated. Please use the ‘defaultWidth’ property instead. Represents width of default position in units of 1/4000 of the chart area.

getDefaultWidth() : number;

Remarks

getDefaultHeight()

@deprecated. Please use the ‘defaultHeight’ property instead. Represents height of default position in units of 1/4000 of the chart area.

getDefaultHeight() : number;

Remarks

getDefaultXRatioToChart()

@deprecated. Please use the ‘defaultXRatioToChart’ property instead. Represents x of default position in units of Fraction of the chart area.

getDefaultXRatioToChart() : number;

getDefaultYRatioToChart()

@deprecated. Please use the ‘defaultYRatioToChart’ property instead. Represents y of default position in units of Fraction of the chart area.

getDefaultYRatioToChart() : number;

getDefaultWidthRatioToChart()

@deprecated. Please use the ‘defaultWidthRatioToChart’ property instead. Represents width of default position in units of Fraction of the chart area.

getDefaultWidthRatioToChart() : number;

getDefaultHeightRatioToChart()

@deprecated. Please use the ‘defaultHeightRatioToChart’ property instead. Represents height of default position in units of Fraction of the chart area.

getDefaultHeightRatioToChart() : number;

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

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().

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

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.

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;

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.