Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class ChartArea

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

public class ChartArea
extends java.lang.Object

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


Method Summary
 Area getArea()
          Gets the Area.
 Line getBorder()
          Gets the border Line.
 Font getFont()
          Gets a Font object of the chart area.
 int getHeight()
          Gets the height, in unit of pixel.
 double getHeightCM()
          Gets the height, in unit of centimeters.
 float getHeightInch()
          Gets the height, in unit of inches.
 int getLeft()
          Gets the horizontal offset of textbox from its left column, in unit of pixel.
 double getLeftCM()
          Gets the horizontal offset of textbox from its left column, in unit of centimeters.
 float getLeftInch()
          Gets the horizontal offset of textbox from its left column, in unit of inches.
 int getPlacement()
          Gets the way the drawing obejct is attached to the cells below it.
 int getTop()
          Gets the vertical offset of textbox from its top row, in unit of pixel.
 double getTopCM()
          Gets the vertical offset of textbox from its top row, in unit of centimeters.
 float getTopInch()
          Gets the vertical offset of textbox from its top row, in unit of inches.
 int getUpperLeftColumn()
          Gets the upper left column index.
 int getUpperLeftRow()
          Gets the upper left row index.
 int getWidth()
          Gets the widthx, in unit of pixel.
 double getWidthCM()
          Gets the width, in unit of centimeters.
 float getWidthInch()
          Gets the width, in unit of inches.
 boolean isRectangularCornered()
          Indicates whether area is rectangular cornered.Default is true.
 boolean isShadow()
          Indicates whether the chart area has a shadow.
 void setFont(Font font)
          Sets a Font object of the chart area.
 void setHeight(int height)
          Sets the height, in unit of pixel.
 void setHeightCM(double height)
          Sets the height, in unit of centimeters.
 void setHeightInch(double height)
          Sets the height, in unit of inches.
 void setLeft(int left)
          Sets the horizontal offset of textbox from its left column, in unit of pixel.
 void setLeftCM(double left)
          Sets the horizontal offset of textbox from its left column, in unit of centimeters.
 void setLeftInch(double left)
          Sets the horizontal offset of textbox from its left column, in unit of inches.
 void setPlacement(byte placementType)
          Sets the way the drawing obejct is attached to the cells below it.
 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)
          Sets the vertical offset of textbox from its top row, in unit of pixel.
 void setTopCM(double top)
          Sets the vertical offset of textbox from its top row, in unit of centimeters.
 void setTopInch(double top)
          Sets the vertical offset of textbox from its top row, in unit of inches.
 void setUpperLeftColumn(int column)
          Sets the upper left column index.
 void setUpperLeftRow(int row)
          Sets the upper left row index.
 void setWidth(int width)
          Sets the width, in unit of pixel.
 void setWidthCM(double width)
          Sets the width, in unit of centimeters.
 void setWidthInch(double width)
          Sets the width, in unit of inches.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, 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.

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.

getUpperLeftColumn

public int getUpperLeftColumn()
Gets the upper left column index.

Returns:
the upper leftcolumn index.

setUpperLeftColumn

public void setUpperLeftColumn(int column)
Sets the upper left column index.

Parameters:
column - the upper left column index .

getUpperLeftRow

public int getUpperLeftRow()
Gets the upper left row index.

Returns:
the upper left row index.

setUpperLeftRow

public void setUpperLeftRow(int row)
Sets the upper left row index.

Parameters:
row - the upper left row index.

getHeight

public int getHeight()
Gets the height, in unit of pixel.

Returns:
the height, in unit of pixel.

setHeight

public void setHeight(int height)
Sets the height, in unit of pixel.

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

getHeightInch

public float getHeightInch()
Gets the height, in unit of inches.

Returns:
the height, in unit of inches.

setHeightInch

public void setHeightInch(double height)
Sets the height, in unit of inches.

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

getHeightCM

public double getHeightCM()
Gets the height, in unit of centimeters.

Returns:
the height, in unit of centimeters.

setHeightCM

public void setHeightCM(double height)
Sets the height, in unit of centimeters.

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

getWidth

public int getWidth()
Gets the widthx, in unit of pixel.

Returns:
the width, in unit of pixel.

setWidth

public void setWidth(int width)
Sets the width, in unit of pixel.

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

getWidthInch

public float getWidthInch()
Gets the width, in unit of inches.

Returns:
the width, in unit of inches.

setWidthInch

public void setWidthInch(double width)
Sets the width, in unit of inches.

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

getWidthCM

public double getWidthCM()
Gets the width, in unit of centimeters.

Returns:
the width, in unit of centimeters.

setWidthCM

public void setWidthCM(double width)
Sets the width, in unit of centimeters.

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

getLeft

public int 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)
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()
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)
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()
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)
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()
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)
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()
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)
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()
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)
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()
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)
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

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.

getBorder

public Line getBorder()
Gets the border Line.

Returns:
the border Line.
Throws:
CellsException - if chart has bean removed.

getArea

public Area getArea()
Gets the Area.

Returns:
the Area.
Throws:
CellsException - if chart has bean removed.