com.aspose.cells

Class ChartFrame

java.lang.Object

com.aspose.cells.ChartFrame

Direct Known Subclasses:

ChartArea, ChartTextFrame, PlotArea

public class ChartFrame
extends java.lang.Object

Encapsulates the object that represents the frame object in a chart.

Method Summary

Methods

Modifier and Type	Method and Description
Area	getArea() Gets the Area.
boolean	getAutoScaleFont() True if the text in the object changes font size when the object size changes.
int	getBackground() Deprecated. Use ChartFrame.BackgroundMode property instead.
int	getBackgroundMode() Gets the display mode of the background
Line	getBorder() Gets the Line.
Chart	getChart() Gets the chart to which this object belongs.
int	getDefaultHeight() Deprecated. Use ChartFrame.DefaultHeightRatioToChart property, instead.
double	getDefaultHeightRatioToChart() Represents height of default position in units of Fraction of the chart area.
int	getDefaultWidth() Deprecated. Use ChartFrame.DefaultWidthRatioToChart property, instead.
double	getDefaultWidthRatioToChart() Represents width of default position in units of Fraction of the chart area.
int	getDefaultX() Deprecated. Use ChartFrame.DefaultXRatioToChart property, instead.
double	getDefaultXRatioToChart() Represents x of default position in units of Fraction of the chart area.
int	getDefaultY() Deprecated. Use ChartFrame.DefaultYRatioToChart property, instead.
double	getDefaultYRatioToChart() Represents y of default position in units of Fraction of the chart area.
Font	getFont() Gets a ChartArea.getFont() object of the specified ChartFrame object.
int	getHeight() Deprecated. Use ChartFrame.HeightRatioToChart property, instead.
int	getHeightPixel() Gets the height of frame in units of Pixel.
double	getHeightRatioToChart() Gets the height of frame in units of ratio of the chart area.
boolean	getShadow() True if the frame has a shadow.
ShapePropertyCollection	getShapeProperties() Gets the getShapeProperties() object.
Font	getTextFont() Deprecated. Use ChartFrame.Font property instead.
TextOptions	getTextOptions() Gets the options of the text.
int	getWidth() Deprecated. Use ChartFrame.WidthRatioToChart property, instead.
int	getWidthPixel() Gets the width of frame in units of Pixel.
double	getWidthRatioToChart() Gets the width of frame in units of ratio of the chart area.
int	getX() Deprecated. Use ChartFrame.XRatioToChart property, instead.
int	getXPixel() Gets the x coordinate of the upper left corner in units of Pixel.
double	getXRatioToChart() Gets the x coordinate of the upper left corner in units of ratio of the chart area.
int	getY() Deprecated. Use ChartFrame.YRatioToChart property, instead.
int	getYPixel() Gets the y coordinate of the upper left corner in units of Pixel.
double	getYRatioToChart() Gets the y coordinate of the upper left corner in units of ratio of the chart area.
boolean	isAutomaticSize() Indicates whether the chart frame is automatic sized.
boolean	isDefaultPosBeSet() Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
boolean	isInnerMode() Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
void	setAutomaticSize(boolean value) Indicates whether the chart frame is automatic sized.
void	setAutoScaleFont(boolean value) True if the text in the object changes font size when the object size changes.
void	setBackground(int value) Deprecated. Use ChartFrame.BackgroundMode property instead.
void	setBackgroundMode(int value) Sets the display mode of the background
void	setHeight(int value) Deprecated. Use ChartFrame.HeightRatioToChart property, instead.
void	setHeightPixel(int value) Sets the height of frame in units of Pixel.
void	setHeightRatioToChart(double value) Sets the height of frame in units of ratio of the chart area.
void	setInnerMode(boolean value) Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
void	setPositionAuto() Set position of the frame to automatic
void	setShadow(boolean value) True if the frame has a shadow.
void	setWidth(int value) Deprecated. Use ChartFrame.WidthRatioToChart property, instead.
void	setWidthPixel(int value) Sets the width of frame in units of Pixel.
void	setWidthRatioToChart(double value) Sets the width of frame in units of ratio of the chart area.
void	setX(int value) Deprecated. Use ChartFrame.XRatioToChart property, instead.
void	setXPixel(int value) Sets the x coordinate of the upper left corner in units of Pixel.
void	setXRatioToChart(double value) Sets the x coordinate of the upper left corner in units of ratio of the chart area.
void	setY(int value) Deprecated. Use ChartFrame.YRatioToChart property, instead.
void	setYPixel(int value) Sets the y coordinate of the upper left corner in units of Pixel.
void	setYRatioToChart(double value) Sets the y coordinate of the upper left corner in units of ratio of the chart area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

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.

setInnerMode

public void setInnerMode(boolean value)

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.

getChart

public Chart getChart()

Gets the chart to which this object belongs.

getBorder

public Line getBorder()

Gets the Line.

getArea

public Area getArea()

Gets the Area.

getTextFont

public Font getTextFont()

Deprecated. Use ChartFrame.Font property instead.

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.

getTextOptions

public TextOptions getTextOptions()

Gets the options of the text.

getFont

public Font getFont()

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

getAutoScaleFont

public boolean getAutoScaleFont()

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

setAutoScaleFont

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.

getBackgroundMode

public int getBackgroundMode()

Gets the display mode of the background

See BackgroundMode.

setBackgroundMode

public void setBackgroundMode(int value)

Sets the display mode of the background

See BackgroundMode.

getBackground

public int getBackground()

Deprecated. Use ChartFrame.BackgroundMode property instead.

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.

setBackground

public void setBackground(int value)

Deprecated. Use ChartFrame.BackgroundMode property instead.

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

isAutomaticSize

public boolean isAutomaticSize()

Indicates whether the chart frame is automatic sized.

setAutomaticSize

public void setAutomaticSize(boolean value)

Indicates whether the chart frame is automatic sized.

getX

public int getX()

Deprecated. Use ChartFrame.XRatioToChart property, instead.

Gets the x coordinate of the upper left corner in units of 1/4000 of the chart area.

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

setX

public void setX(int value)

Deprecated. Use ChartFrame.XRatioToChart property, instead.

Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

getY

public int getY()

Deprecated. Use ChartFrame.YRatioToChart property, instead.

Gets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

setY

public void setY(int value)

Deprecated. Use ChartFrame.YRatioToChart property, instead.

Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

getHeight

public int getHeight()

Deprecated. Use ChartFrame.HeightRatioToChart property, instead.

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

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

setHeight

public void setHeight(int value)

Deprecated. Use ChartFrame.HeightRatioToChart property, instead.

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

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

getWidth

public int getWidth()

Deprecated. Use ChartFrame.WidthRatioToChart property, instead.

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

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

setWidth

public void setWidth(int value)

Deprecated. Use ChartFrame.WidthRatioToChart property, instead.

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

Remarks

NOTE: This member is now obsolete. Please use ChartFrame.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.

getShadow

public boolean getShadow()

True if the frame has a shadow.

setShadow

public void setShadow(boolean value)

True if the frame has a shadow.

getShapeProperties

public ShapePropertyCollection getShapeProperties()

Gets the getShapeProperties() object.

isDefaultPosBeSet

public boolean isDefaultPosBeSet()

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

getDefaultX

public int getDefaultX()

Deprecated. Use ChartFrame.DefaultXRatioToChart property, instead.

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.

getDefaultY

public int getDefaultY()

Deprecated. Use ChartFrame.DefaultYRatioToChart property, instead.

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.

getDefaultWidth

public int getDefaultWidth()

Deprecated. Use ChartFrame.DefaultWidthRatioToChart property, instead.

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.

getDefaultHeight

public int getDefaultHeight()

Deprecated. Use ChartFrame.DefaultHeightRatioToChart property, instead.

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.

getDefaultXRatioToChart

public double getDefaultXRatioToChart()

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

getDefaultYRatioToChart

public double getDefaultYRatioToChart()

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

getDefaultWidthRatioToChart

public double getDefaultWidthRatioToChart()

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

getDefaultHeightRatioToChart

public double getDefaultHeightRatioToChart()

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

getXRatioToChart

public double getXRatioToChart()

Gets the x coordinate of the upper left corner in units of ratio of the chart area.

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? XPixel = XRatioToChart * Chart.ChartObject.Width;

setXRatioToChart

public void setXRatioToChart(double value)

Sets the x coordinate of the upper left corner in units of ratio of the chart area.

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? XPixel = XRatioToChart * Chart.ChartObject.Width;

getYRatioToChart

public double getYRatioToChart()

Gets the y coordinate of the upper left corner in units of ratio of the chart area.

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? YPixel = YRatioToChart * Chart.ChartObject.Height;

setYRatioToChart

public void setYRatioToChart(double value)

Sets the y coordinate of the upper left corner in units of ratio of the chart area.

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? YPixel = YRatioToChart * Chart.ChartObject.Height;

getWidthRatioToChart

public double getWidthRatioToChart()

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

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? WidthPixel = WidthRatioToChart * Chart.ChartObject.Width;

setWidthRatioToChart

public void setWidthRatioToChart(double value)

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

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? WidthPixel = WidthRatioToChart * Chart.ChartObject.Width;

getHeightRatioToChart

public double getHeightRatioToChart()

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

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? HeightPixel = HeightRatioToChart * Chart.ChartObject.Height;

setHeightRatioToChart

public void setHeightRatioToChart(double value)

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

Remarks

This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? HeightPixel = HeightRatioToChart * Chart.ChartObject.Height;

getXPixel

public int getXPixel()

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

setXPixel

public void setXPixel(int value)

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

getYPixel

public int getYPixel()

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

setYPixel

public void setYPixel(int value)

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

getWidthPixel

public int getWidthPixel()

Gets the width of frame in units of Pixel.

setWidthPixel

public void setWidthPixel(int value)

Sets the width of frame in units of Pixel.

getHeightPixel

public int getHeightPixel()

Gets the height of frame in units of Pixel.

setHeightPixel

public void setHeightPixel(int value)

Sets the height of frame in units of Pixel.

setPositionAuto

public void setPositionAuto()

Set position of the frame to automatic