PlotArea

Inheritance: java.lang.Object, com.aspose.cells.ChartFrame

public class PlotArea extends ChartFrame

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

Methods

Method	Description
equals(Object arg0)
getArea()	Gets the Area.
getAutoScaleFont()	True if the text in the object changes font size when the object size changes.
getBackground()	Gets the display mode of the background
getBackgroundMode()	Gets the display mode of the background
getBorder()	Gets the Line.
getChart()	Gets the chart to which this object belongs.
getClass()
getDefaultHeight()	Represents height of default position in units of 1/4000 of the chart area.
getDefaultHeightRatioToChart()	Represents height of default position in units of Fraction of the chart area.
getDefaultWidth()	Represents width of default position in units of 1/4000 of the chart area.
getDefaultWidthRatioToChart()	Represents width of default position in units of Fraction of the chart area.
getDefaultX()	Represents x 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.
getDefaultY()	Represents y of default position in units of 1/4000 of the chart area.
getDefaultYRatioToChart()	Represents y of default position in units of Fraction of the chart area.
getFont()	Gets a ChartArea.getFont() object of the specified ChartFrame object.
getHeight()	Gets the height of plot-area bounding box in units of 1/4000 of the chart area.
getHeightPixel()	Gets the height of frame in units of Pixel.
getHeightRatioToChart()	Gets the height of plot-area bounding box in units of ratio of the chart area.
getInnerHeight()	Gets the height of plot area in units of 1/4000 of the chart area.
getInnerHeightRatioToChart()	Gets the height of plot area in units of ratio of the chart area.
getInnerWidth()	Gets the width of plot area in units of 1/4000 of the chart area.
getInnerWidthRatioToChart()	Gets the width of plot area in units of ratio 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.
getInnerXRatioToChart()	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio 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.
getInnerYRatioToChart()	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
getShadow()	True if the frame has a shadow.
getShapeProperties()	Gets the getShapeProperties() object.
getTextFont()	Gets a ChartArea.getFont() object of the specified ChartFrame object.
getTextOptions()	Gets the options of the text.
getWidth()	Gets the width of plot-area bounding box in units of 1/4000 of the chart area.
getWidthPixel()	Gets the width of frame in units of Pixel.
getWidthRatioToChart()	Gets the width of plot-area bounding box in units of ratio 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.
getXPixel()	Gets the x coordinate of the upper left corner in units of Pixel.
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.
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.
getYPixel()	Gets the y coordinate of the upper left corner in units of Pixel.
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.
hashCode()
isAutomaticSize()	Indicates whether the plot area is automatic sized.
isDefaultPosBeSet()	Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
isInnerMode()	Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
notify()
notifyAll()
setAutoScaleFont(boolean value)	True if the text in the object changes font size when the object size changes.
setAutomaticSize(boolean value)	Indicates whether the plot area is automatic sized.
setBackground(int value)	Sets the display mode of the background
setBackgroundMode(int value)	Sets the display mode of the background
setHeight(int value)	Sets the height of plot-area bounding box in units of 1/4000 of the chart area.
setHeightPixel(int value)	Sets the height of frame in units of Pixel.
setHeightRatioToChart(double value)	Sets the height of plot-area bounding box in units of ratio of the chart area.
setInnerHeight(int value)	Sets the height of plot area in units of 1/4000 of the chart area.
setInnerHeightRatioToChart(double value)	Sets the height of plot area in units of ratio of the chart area.
setInnerMode(boolean value)	Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
setInnerWidth(int value)	Sets the width of plot area in units of 1/4000 of the chart area.
setInnerWidthRatioToChart(double value)	Sets the width of plot area in units of ratio of the chart area.
setInnerX(int value)	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
setInnerXRatioToChart(double value)	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setInnerY(int value)	Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
setInnerYRatioToChart(double value)	Gets or gets the x coordinate of the upper top corner of plot area in units of ratio of the chart area.
setPositionAuto()	Set position of the plot area to automatic
setShadow(boolean value)	True if the frame has a shadow.
setWidth(int value)	Sets the width of plot-area bounding box in units of 1/4000 of the chart area.
setWidthPixel(int value)	Sets the width of frame in units of Pixel.
setWidthRatioToChart(double value)	Sets the width of plot-area bounding box in units of ratio of the chart area.
setX(int value)	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.
setXPixel(int value)	Sets the x coordinate of the upper left corner in units of Pixel.
setXRatioToChart(double value)	Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of ratio of the chart area.
setY(int value)	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.
setYPixel(int value)	Sets the y coordinate of the upper left corner in units of Pixel.
setYRatioToChart(double value)	Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of ratio of the chart area.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getArea()

public Area getArea()

Gets the Area.

Returns: Area

getAutoScaleFont()

public boolean getAutoScaleFont()

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

Returns: boolean

getBackground()

public int getBackground()

Gets the display mode of the background

See BackgroundMode.

Remarks

NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getBackgroundMode()

public int getBackgroundMode()

Gets the display mode of the background

See BackgroundMode.

Returns: int

getBorder()

public Line getBorder()

Gets the Line.

Returns: Line

getChart()

public Chart getChart()

Gets the chart to which this object belongs.

Returns: Chart

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getDefaultHeight()

public int getDefaultHeight()

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

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.

Returns: int

getDefaultHeightRatioToChart()

public double getDefaultHeightRatioToChart()

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

Returns: double

getDefaultWidth()

public int getDefaultWidth()

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

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.

Returns: int

getDefaultWidthRatioToChart()

public double getDefaultWidthRatioToChart()

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

Returns: double

getDefaultX()

public int getDefaultX()

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

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.

Returns: int

getDefaultXRatioToChart()

public double getDefaultXRatioToChart()

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

Returns: double

getDefaultY()

public int getDefaultY()

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

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.

Returns: int

getDefaultYRatioToChart()

public double getDefaultYRatioToChart()

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

Returns: double

getFont()

public Font getFont()

Gets a ChartArea.getFont() object of the specified ChartFrame object.

Returns: Font

getHeight()

public int getHeight()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.HeightRatioToChart property, instead. Height = HeightRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getHeightPixel()

public int getHeightPixel()

Gets the height of frame in units of Pixel.

Returns: int

getHeightRatioToChart()

public double getHeightRatioToChart()

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

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

HeightPixel = HeightRatioToChart * chart.ChartObject.Width.

Returns: double

getInnerHeight()

public int getInnerHeight()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.InnerHeightRatioToChart property, instead. InnerHeight = InnerHeightRatioToChart * 4000; This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getInnerHeightRatioToChart()

public double getInnerHeightRatioToChart()

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

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.

Returns: double

getInnerWidth()

public int getInnerWidth()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.InnerWidthRatioToChart property, instead. InnerWidth = InnerWidthRatioToChart * 4000; This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getInnerWidthRatioToChart()

public double getInnerWidthRatioToChart()

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

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.

Returns: double

getInnerX()

public int getInnerX()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.InnerXRatioToChart property, instead. InnerX = InnerXRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getInnerXRatioToChart()

public double getInnerXRatioToChart()

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

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.

Returns: double

getInnerY()

public int getInnerY()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.InnerYRatioToChart property, instead. InnerY = InnerYRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getInnerYRatioToChart()

public double getInnerYRatioToChart()

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

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.

Returns: double

getShadow()

public boolean getShadow()

True if the frame has a shadow.

Returns: boolean

getShapeProperties()

public ShapePropertyCollection getShapeProperties()

Gets the getShapeProperties() object.

Returns: ShapePropertyCollection

getTextFont()

public Font getTextFont()

Gets a ChartArea.getFont() object of the specified ChartFrame object.

Remarks

NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

Returns: Font

getTextOptions()

public TextOptions getTextOptions()

Gets the options of the text.

Returns: TextOptions

getWidth()

public int getWidth()

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

Remarks

NOTE: This member is now obsolete. Please use PlotArea.WidthRatioToChart property, instead. Width = WidthRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getWidthPixel()

public int getWidthPixel()

Gets the width of frame in units of Pixel.

Returns: int

getWidthRatioToChart()

public double getWidthRatioToChart()

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

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.

Returns: double

getX()

public int 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.

Remarks

NOTE: This member is now obsolete. Please use PlotArea.XRatioToChart property, instead. X = XRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getXPixel()

public int getXPixel()

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

Returns: int

getXRatioToChart()

public double 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.

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.

Returns: double

getY()

public int 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.

Remarks

NOTE: This member is now obsolete. Please use PlotArea.YRatioToChart property, instead. Y = YRatioToChart * 4000. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: int

getYPixel()

public int getYPixel()

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

Returns: int

getYRatioToChart()

public double 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.

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.

Returns: double

hashCode()

public native int hashCode()

Returns: int

isAutomaticSize()

public boolean isAutomaticSize()

Indicates whether the plot area is automatic sized.

Returns: boolean

isDefaultPosBeSet()

public boolean isDefaultPosBeSet()

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

Returns: boolean

isInnerMode()

public 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.

Remarks

Only for Xlsx file.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAutoScaleFont(boolean value)

public void setAutoScaleFont(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setAutomaticSize(boolean value)

public void setAutomaticSize(boolean value)

Indicates whether the plot area is automatic sized.

Parameters:

Parameter	Type	Description
value	boolean

setBackground(int value)

public void setBackground(int value)

Sets the display mode of the background

See BackgroundMode.

Remarks

Parameters:

Parameter	Type	Description
value	int

setBackgroundMode(int value)

public void setBackgroundMode(int value)

Sets the display mode of the background

See BackgroundMode.

Parameters:

Parameter	Type	Description
value	int

setHeight(int value)

public void setHeight(int value)

Sets the height of plot-area bounding box in units of 1/4000 of the chart area.

Remarks

Parameters:

Parameter	Type	Description
value	int

setHeightPixel(int value)

public void setHeightPixel(int value)

Sets the height of frame in units of Pixel.

Parameters:

Parameter	Type	Description
value	int

setHeightRatioToChart(double value)

public void setHeightRatioToChart(double value)

Sets the height of plot-area bounding box in units of ratio of the chart area.

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.

Parameters:

Parameter	Type	Description
value	double

setInnerHeight(int value)

public void setInnerHeight(int value)

Sets the height of plot area in units of 1/4000 of the chart area.

Remarks

Parameters:

Parameter	Type	Description
value	int

setInnerHeightRatioToChart(double value)

public void setInnerHeightRatioToChart(double value)

Sets the height of plot area in units of ratio of the chart area.

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.

Parameters:

Parameter	Type	Description
value	double

setInnerMode(boolean value)

public void setInnerMode(boolean value)

Remarks

Only for Xlsx file.

Parameters:

Parameter	Type	Description
value	boolean

setInnerWidth(int value)

public void setInnerWidth(int value)

Sets the width of plot area in units of 1/4000 of the chart area.

Remarks

Parameters:

Parameter	Type	Description
value	int

setInnerWidthRatioToChart(double value)

public void setInnerWidthRatioToChart(double value)

Sets the width of plot area in units of ratio of the chart area.

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.

Parameters:

Parameter	Type	Description
value	double

setInnerX(int value)

public void setInnerX(int value)

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

Remarks

Parameters:

Parameter	Type	Description
value	int

setInnerXRatioToChart(double value)

public void setInnerXRatioToChart(double value)

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

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.

Parameters:

Parameter	Type	Description
value	double

setInnerY(int value)

public void setInnerY(int value)

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

Remarks

Parameters:

Parameter	Type	Description
value	int

setInnerYRatioToChart(double value)

public void setInnerYRatioToChart(double value)

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

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.

Parameters:

Parameter	Type	Description
value	double

setPositionAuto()

public void setPositionAuto()

Set position of the plot area to automatic

setShadow(boolean value)

public void setShadow(boolean value)

True if the frame has a shadow.

Parameters:

Parameter	Type	Description
value	boolean

setWidth(int value)

public void setWidth(int value)

Sets the width of plot-area bounding box in units of 1/4000 of the chart area.

Remarks

Parameters:

Parameter	Type	Description
value	int

setWidthPixel(int value)

public void setWidthPixel(int value)

Sets the width of frame in units of Pixel.

Parameters:

Parameter	Type	Description
value	int

setWidthRatioToChart(double value)

public void setWidthRatioToChart(double value)

Sets the width of plot-area bounding box in units of ratio of the chart area.

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.

Parameters:

Parameter	Type	Description
value	double

setX(int value)

public void setX(int value)

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.

Remarks

Parameters:

Parameter	Type	Description
value	int

setXPixel(int value)

public void setXPixel(int value)

Sets the x coordinate of the upper left corner in units of Pixel.

Parameters:

Parameter	Type	Description
value	int

setXRatioToChart(double value)

public void setXRatioToChart(double value)

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

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.

Parameters:

Parameter	Type	Description
value	double

setY(int value)

public void setY(int value)

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.

Remarks

Parameters:

Parameter	Type	Description
value	int

setYPixel(int value)

public void setYPixel(int value)

Sets the y coordinate of the upper left corner in units of Pixel.

Parameters:

Parameter	Type	Description
value	int

setYRatioToChart(double value)

public void setYRatioToChart(double value)

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

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.

Parameters:

Parameter	Type	Description
value	double

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int