Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class Legend

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

public class Legend
extends java.lang.Object

Encapsulates the object that represents the chart legend.


Method Summary
 Area getArea()
          Gets the Area.
 Line getBorder()
          Gets the border Line.
 Font getFont()
          Gets a Font object of the chart legend.
 int getPosition()
          Gets the legend position type.
 void setFont(Font font)
          Sets a Font object of the chart legend.
 void setPosition(int legendPositionType)
          Sets the legend position type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPosition

public int getPosition()
Gets the legend position type.

Returns:
the legend position type.
Throws:
ExcelException - if chart has bean removed.
See Also:
setPosition(int)

setPosition

public void setPosition(int legendPositionType)
Sets the legend position type.

Parameters:
legendPositionType - the legend position type. It could be one of the following values:
LegendPositionType.BOTTOM
LegendPositionType.CORNER
LegendPositionType.TOP
LegendPositionType.RIGHT
LegendPositionType.LEFT
LegendPositionType.NOT_DOCKED
Throws:
java.lang.IllegalArgumentException - if legend position type is invalid.
ExcelException - if chart has bean removed.

getFont

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

Returns:
a Font object of the chart legend.
Throws:
ExcelException - if chart has bean removed.

setFont

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

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

getBorder

public Line getBorder()
Gets the border Line.

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

getArea

public Area getArea()
Gets the Area.

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