Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class ChartArea

java.lang.Object
  extended by com.aspose.cells.ChartFrame
      extended by com.aspose.cells.ChartArea

public class ChartArea
extends ChartFrame

Encapsulates the object that represents the chart area in the worksheet.


Method Summary
 byte getBackgroundMode()
          Gets the display mode of the background.
 Font getFont()
          Gets a Font object of the chart area.
 int getHeight()
          Deprecated. replaced by Shape.getHeight()
 double getHeightCM()
          Deprecated. replaced by Shape.getHeightCM()
 float getHeightInch()
          Deprecated. replaced by Shape.getHeightInch()
 int getLeft()
          Deprecated. replaced by Shape.getLeft()
 double getLeftCM()
          Deprecated. replaced by Shape.getLeftCM()
 float getLeftInch()
          Deprecated. replaced by Shape.getLeftInch()
 int getPlacement()
          Deprecated. replaced by Shape.getPlacement()
 int getTop()
          Deprecated. replaced by Shape.getTop()
 double getTopCM()
          Deprecated. replaced by Shape.getTopCM()
 float getTopInch()
          Deprecated. replaced by Shape.getTopInch()
 int getUpperLeftColumn()
          Deprecated. replaced by Shape.getUpperLeftColumn()
 int getUpperLeftRow()
          Deprecated. replaced by Shape.getUpperLeftRow()
 int getWidth()
          Deprecated. replaced by Shape.getWidth()
 double getWidthCM()
          Deprecated. replaced by Shape.getWidthCM()
 float getWidthInch()
          Deprecated. replaced by Shape.getWidthInch()
 boolean isAutoScaleFont()
          Check whether the text in the object changes font size when the object size changes.
 boolean isRectangularCornered()
          Indicates whether area is rectangular cornered.Default is true.
 boolean isShadow()
          Indicates whether the chart area has a shadow.
 void setAutoScaleFont(boolean isAutoScaleFont)
          Set whether the text in the object changes font size when the object size changes.
 void setBackgroundMode(byte mode)
          Sets the display mode of the background.
 void setFont(Font font)
          Sets a Font object of the chart area.
 void setHeight(int height)
          Deprecated. replaced by Shape.setHeight(int)
 void setHeightCM(double height)
          Deprecated. replaced by Shape.setHeightCM(double)
 void setHeightInch(double height)
          Deprecated. replaced by Shape.setHeightInch(double)
 void setLeft(int left)
          Deprecated. if in Chart, use Shape.setLeftInChart(int) instead; if in common sheet, use Shape.setLeftPositionInPixel(short, short) instead.
 void setLeftCM(double left)
          Deprecated. replaced by Shape.setLeftCM(double)
 void setLeftInch(double left)
          Deprecated. replaced by Shape.setLeftInch(double)
 void setPlacement(byte placementType)
          Deprecated. replaced by Shape.setPlacement(byte)
 void setRectangularCornered(boolean isRectangularCornered)
          Sets whether area is rectangular cornered.Default is true.
 void setShadow(boolean isShadow)
          Sets whether the chart area has a shadow.
 void setTop(int top)
          Deprecated. if in Chart, use Shape.setTopInChart(int) instead; if in common sheet, use Shape.setTopPositionInPixel(int, short) instead.
 void setTopCM(double top)
          Deprecated. replaced by Shape.setTopCM(double)
 void setTopInch(double top)
          Deprecated. replaced by Shape.setTopInch(double)
 void setUpperLeftColumn(int column)
          Deprecated. replaced by Shape.setLeftPosition(short, short)
 void setUpperLeftRow(int row)
          Deprecated. replaced by Shape.setTopPosition(int, short)
 void setWidth(int width)
          Deprecated. replaced by Shape.setWidth(int)
 void setWidthCM(double width)
          Deprecated. replaced by Shape.setWidthCM(double)
 void setWidthInch(double width)
          Deprecated. replaced by Shape.setWidthInch(double)
 
Methods inherited from class com.aspose.cells.ChartFrame
equals, getArea, getAreaOrNull, getBorder, getBorderOrNull
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFont

public Font getFont()
Gets a Font object of the chart area.

Returns:
Font object of the chart area.
Throws:
CellsException - if chart has bean removed.

setFont

public void setFont(Font font)
Sets a Font object of the chart area.

Parameters:
font - a Font object of the chart area.
Throws:
CellsException - if chart has bean removed.

isAutoScaleFont

public boolean isAutoScaleFont()
Check whether the text in the object changes font size when the object size changes.

Returns:
true if the text in the object changes font size when the object size changes.

setAutoScaleFont

public void setAutoScaleFont(boolean isAutoScaleFont)
Set whether the text in the object changes font size when the object size changes.

Parameters:
isAutoScaleFont - true if the text in the object changes font size when the object size changes.

getBackgroundMode

public byte getBackgroundMode()
Gets the display mode of the background.

Returns:
the display mode of the background.
See Also:
setBackgroundMode(byte)

setBackgroundMode

public void setBackgroundMode(byte mode)
Sets the display mode of the background.

Parameters:
mode - the display mode of the background. It could be one of following:
BackgroundMode.AUTOMATIC
BackgroundMode.TRANSPARENT
BackgroundMode.OPAQUE

setShadow

public void setShadow(boolean isShadow)
Sets whether the chart area has a shadow.

Parameters:
isShadow - whether the chart area has a shadow.
Throws:
CellsException - if chart has bean removed.

isShadow

public boolean isShadow()
Indicates whether the chart area has a shadow.

Returns:
whether the chart area has a shadow.
Throws:
CellsException - if chart has bean removed.

isRectangularCornered

public boolean isRectangularCornered()
Indicates whether area is rectangular cornered.Default is true.

Returns:
whether area is rectangular cornered.

setRectangularCornered

public void setRectangularCornered(boolean isRectangularCornered)
Sets whether area is rectangular cornered.Default is true.

Parameters:
isRectangularCornered - whether area is rectangular cornered.

getUpperLeftColumn

public int getUpperLeftColumn()
Deprecated. replaced by Shape.getUpperLeftColumn()

Gets the upper left column index.

Returns:
the upper leftcolumn index.

setUpperLeftColumn

public void setUpperLeftColumn(int column)
Deprecated. replaced by Shape.setLeftPosition(short, short)

Sets the upper left column index.

Parameters:
column - the upper left column index .

getUpperLeftRow

public int getUpperLeftRow()
Deprecated. replaced by Shape.getUpperLeftRow()

Gets the upper left row index.

Returns:
the upper left row index.

setUpperLeftRow

public void setUpperLeftRow(int row)
Deprecated. replaced by Shape.setTopPosition(int, short)

Sets the upper left row index.

Parameters:
row - the upper left row index.

getHeight

public int getHeight()
Deprecated. replaced by Shape.getHeight()

Gets the height, in unit of pixel.

Returns:
the height, in unit of pixel.

setHeight

public void setHeight(int height)
Deprecated. replaced by Shape.setHeight(int)

Sets the height, in unit of pixel.

Parameters:
height - the height, in unit of pixel.

getHeightInch

public float getHeightInch()
Deprecated. replaced by Shape.getHeightInch()

Gets the height, in unit of inches.

Returns:
the height, in unit of inches.

setHeightInch

public void setHeightInch(double height)
Deprecated. replaced by Shape.setHeightInch(double)

Sets the height, in unit of inches.

Parameters:
height - the heigh, in unit of inches.

getHeightCM

public double getHeightCM()
Deprecated. replaced by Shape.getHeightCM()

Gets the height, in unit of centimeters.

Returns:
the height, in unit of centimeters.

setHeightCM

public void setHeightCM(double height)
Deprecated. replaced by Shape.setHeightCM(double)

Sets the height, in unit of centimeters.

Parameters:
height - the height, in unit of centimeters.

getWidth

public int getWidth()
Deprecated. replaced by Shape.getWidth()

Gets the widthx, in unit of pixel.

Returns:
the width, in unit of pixel.

setWidth

public void setWidth(int width)
Deprecated. replaced by Shape.setWidth(int)

Sets the width, in unit of pixel.

Parameters:
width - the width, in unit of pixel.

getWidthInch

public float getWidthInch()
Deprecated. replaced by Shape.getWidthInch()

Gets the width, in unit of inches.

Returns:
the width, in unit of inches.

setWidthInch

public void setWidthInch(double width)
Deprecated. replaced by Shape.setWidthInch(double)

Sets the width, in unit of inches.

Parameters:
width - the width, in unit of inches.

getWidthCM

public double getWidthCM()
Deprecated. replaced by Shape.getWidthCM()

Gets the width, in unit of centimeters.

Returns:
the width, in unit of centimeters.

setWidthCM

public void setWidthCM(double width)
Deprecated. replaced by Shape.setWidthCM(double)

Sets the width, in unit of centimeters.

Parameters:
width - the width, in unit of centimeters.

getLeft

public int getLeft()
Deprecated. replaced by Shape.getLeft()

Gets the horizontal offset of textbox from its left column, in unit of pixel.

Returns:
the horizontal offset of textbox from its left column, in unit of pixel.

setLeft

public void setLeft(int left)
Deprecated. if in Chart, use Shape.setLeftInChart(int) instead; if in common sheet, use Shape.setLeftPositionInPixel(short, short) instead.

Sets the horizontal offset of textbox from its left column, in unit of pixel.

Parameters:
left - the horizontal offset of textbox from its left column, in unit of pixel.

getLeftInch

public float getLeftInch()
Deprecated. replaced by Shape.getLeftInch()

Gets the horizontal offset of textbox from its left column, in unit of inches.

Returns:
the horizontal offset of textbox from its left column, in unit of inches.

setLeftInch

public void setLeftInch(double left)
Deprecated. replaced by Shape.setLeftInch(double)

Sets the horizontal offset of textbox from its left column, in unit of inches.

Parameters:
left - the horizontal offset of textbox from its left column, in unit of inches.

getLeftCM

public double getLeftCM()
Deprecated. replaced by Shape.getLeftCM()

Gets the horizontal offset of textbox from its left column, in unit of centimeters.

Returns:
the horizontal offset of textbox from its left column, in unit of centimeters.

setLeftCM

public void setLeftCM(double left)
Deprecated. replaced by Shape.setLeftCM(double)

Sets the horizontal offset of textbox from its left column, in unit of centimeters.

Parameters:
left - the horizontal offset of textbox from its left column, in unit of centimeters.

getTop

public int getTop()
Deprecated. replaced by Shape.getTop()

Gets the vertical offset of textbox from its top row, in unit of pixel.

Returns:
the vertical offset of textbox from its top row, in unit of pixel.

setTop

public void setTop(int top)
Deprecated. if in Chart, use Shape.setTopInChart(int) instead; if in common sheet, use Shape.setTopPositionInPixel(int, short) instead.

Sets the vertical offset of textbox from its top row, in unit of pixel.

Parameters:
top - the vertical offset of textbox from its top row, in unit of pixel.

getTopInch

public float getTopInch()
Deprecated. replaced by Shape.getTopInch()

Gets the vertical offset of textbox from its top row, in unit of inches.

Returns:
the vertical offset of textbox from its top row, in unit of inches.

setTopInch

public void setTopInch(double top)
Deprecated. replaced by Shape.setTopInch(double)

Sets the vertical offset of textbox from its top row, in unit of inches.

Parameters:
top - the vertical offset of textbox from its top row, in unit of inches.

getTopCM

public double getTopCM()
Deprecated. replaced by Shape.getTopCM()

Gets the vertical offset of textbox from its top row, in unit of centimeters.

Returns:
the vertical offset of textbox from its top row, in unit of centimeters.

setTopCM

public void setTopCM(double top)
Deprecated. replaced by Shape.setTopCM(double)

Sets the vertical offset of textbox from its top row, in unit of centimeters.

Parameters:
top - the vertical offset of textbox from its top row, in unit of centimeters.

getPlacement

public int getPlacement()
Deprecated. replaced by Shape.getPlacement()

Gets the way the drawing obejct is attached to the cells below it.

Returns:
the way the drawing obejct is attached to the cells below it.
See Also:
setPlacement(byte)

setPlacement

public void setPlacement(byte placementType)
Deprecated. replaced by Shape.setPlacement(byte)

Sets the way the drawing obejct is attached to the cells below it.

Parameters:
placementType - the way the drawing obejct is attached to the cells below it. It could be one of the following values:
PlacementType.FREE_FLOATING
PlacementType.MOVE
PlacementType.MOVE_AND_SIZE
Throws:
java.lang.IllegalArgumentException - if placementType is not member of PlacementType