![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.ChartFrame
com.aspose.cells.Legend
public class Legend
Encapsulates the object that represents the chart legend.
Method Summary | |
---|---|
byte |
getBackgroundMode()
Gets the display mode of the background. |
Font |
getFont()
Gets a Font object of the chart legend. |
int |
getHeight()
Sets the height of frame, in units of 1/4000 of the chart area. |
LegendEntries |
getLegendEntries()
Gets a collection of all the LegendEntry objects in the specified chart legend. |
int |
getPosition()
Gets the legend position type. |
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 |
isAutoScaleFont()
Check whether the text in the object changes font size when the object size changes. |
boolean |
isShadow()
Indicates if the frame 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 legend. |
void |
setHeight(int height)
Sets the height of frame,in units of 1/4000 of the chart area. |
void |
setPosition(int legendPositionType)
Sets the legend position type. |
void |
setShadow(boolean shadow)
Sets if the frame has a shadow. |
void |
setWidth(int width)
Sets the width of frame,in units of 1/4000 of the chart area. |
void |
setX(int x)
Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. |
void |
setY(int y)
Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
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 |
---|
public LegendEntries getLegendEntries()
public int getPosition()
CellsException
- if chart has bean removed.setPosition(int)
public void setPosition(int legendPositionType)
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 |
java.lang.IllegalArgumentException
- if legend position type is invalid.
CellsException
- if chart has bean removed.public Font getFont()
CellsException
- if chart has bean removed.public void setFont(Font font)
font
- a Font object of the chart legend
CellsException
- if chart has bean removed.public boolean isAutoScaleFont()
public void setAutoScaleFont(boolean isAutoScaleFont)
isAutoScaleFont
- true if the text in the object changes font size when the object size changes.public byte getBackgroundMode()
setBackgroundMode(byte)
public void setBackgroundMode(byte mode)
mode
- the display mode of the background. It could be one of following:
BackgroundMode.AUTOMATIC |
BackgroundMode.TRANSPARENT |
BackgroundMode.OPAQUE |
public boolean isShadow()
public void setShadow(boolean shadow)
shadow
- true if the frame has a shadow.public int getX()
public void setX(int x)
x
- the x coordinate of the upper left corner.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if x > 4000;public int getY()
public void setY(int y)
y
- the y coordinate of the upper left corner.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if y > 4000;public int getHeight()
public void setHeight(int height)
height
- the height of frame.
CellsException
- if chart has bean removed.public int getWidth()
public void setWidth(int width)
width
- the width of frame.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if width > 4000;
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |