ChartFrame (Aspose.Cells for Java)

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()` Represents height of default position
`int`	`getDefaultWidth()` Represents width of default position
`int`	`getDefaultX()` Represents x of default position
`int`	`getDefaultY()` Represents y of default position
`Font`	`getFont()` Gets a `ChartArea.getFont()` object of the specified ChartFrame object.
`int`	`getHeight()` Gets the height of frame in units of 1/4000 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()` Gets the width of frame in units of 1/4000 of the chart area.
`int`	`getX()` Gets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
`int`	`getY()` Gets the y coordinate of the upper left corner in units of 1/4000 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)` Sets the height of frame in units of 1/4000 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)` Sets the width of frame in units of 1/4000 of the chart area.
`void`	`setX(int value)` Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
`void`	`setY(int value)` Sets the y coordinate of the upper left corner in units of 1/4000 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()
```
    Gets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
  - setX
```
public void setX(int value)
```
    Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
  - getY
```
public int getY()
```
    Gets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
  - setY
```
public void setY(int value)
```
    Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
  - getHeight
```
public int getHeight()
```
    Gets the height of frame in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
  - setHeight
```
public void setHeight(int value)
```
    Sets the height of frame in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
  - getWidth
```
public int getWidth()
```
    Gets the width of frame in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;
  - setWidth
```
public void setWidth(int value)
```
    Sets the width of frame in units of 1/4000 of the chart area.
    Remarks
    How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;
  - 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()
```
    Represents x of default position
  - getDefaultY
```
public int getDefaultY()
```
    Represents y of default position
  - getDefaultWidth
```
public int getDefaultWidth()
```
    Represents width of default position
  - getDefaultHeight
```
public int getDefaultHeight()
```
    Represents height of default position
  - setPositionAuto
```
public void setPositionAuto()
```
    Set position of the frame to automatic

Class ChartFrame

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isInnerMode

setInnerMode

getChart

getBorder

getArea

getTextFont

getTextOptions

getFont

getAutoScaleFont

setAutoScaleFont

getBackgroundMode

setBackgroundMode

getBackground

setBackground

isAutomaticSize

setAutomaticSize

getX

setX

getY

setY

getHeight

setHeight

getWidth

setWidth

getShadow

setShadow

getShapeProperties

isDefaultPosBeSet

getDefaultX

getDefaultY

getDefaultWidth

getDefaultHeight

setPositionAuto