![]() |
||
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.Axis
public class Axis
Encapsulates the object that represents a chart's axis.
Method Summary | |
---|---|
Area |
getArea()
Gets the area of Axis for fill formatting. |
Line |
getAxisLine()
Gets the appearance of an axis. |
byte |
getBackgroundMode()
Gets the display mode of the background. |
DisplayUnitLabel |
getDisplayUnitLabel()
Get the unit label on an axis. |
byte |
getDisplayUnitType()
Get the unit label type for the specified axis. |
Font |
getFont()
Gets a Font object that represents the font of the specified TickLabels object. |
Line |
getMajorGridLines()
Gets major gridlines on a chart axis. |
int |
getMajorTickMark()
Gets the type of major tick mark for the axis. |
Line |
getMinorGridLines()
Gets minor gridlines on a chart axis. |
int |
getMinorTickMark()
Gets the type of minor tick mark for the axis. |
int |
getNumber()
Gets the format index for the TickLabels object. |
java.lang.String |
getNumberFormat()
Gets the format string for the TickLabels object. |
int |
getRotation()
Gets text rotation angle. |
int |
getTextDirection()
Gets the text direction type. |
int |
getTickLabelPosition()
Gets the position of tick-mark labels on the axis. |
boolean |
isAutoScaleFont()
Check whether the text in the object changes font size when the object size changes. |
boolean |
isDisplayUnitLabelShown()
If the display unit label is shown on the specified axis. |
boolean |
isNumberFormatLinked()
Indicates if the number format is linked to the cells(so that the number format changes in the labels when it changes in the cells). |
boolean |
isVisible()
Indicates whether the axis is visible. |
void |
setAutoScaleFont(boolean isAutoScaleFont)
Set whether the text in the object changes font size when the object size changes. |
void |
setAxisLine(Line line)
Sets the appearance of an axis. |
void |
setBackgroundMode(byte mode)
Sets the display mode of the background. |
void |
setDisplayUnitLabelShown(boolean isShown)
Sets whether the display unit label is shown on the specified axis |
void |
setDisplayUnitType(byte displayUnitType)
Set the unit label for the specified axis. |
void |
setFont(Font font)
Sets a Font object that represents the font of the specified TickLabels object. |
void |
setMajorTickMark(int majorTickMark)
Sets the type of major tick mark for the axis. |
void |
setMinorTickMark(int minorTickMark)
Sets the type of minor tick mark for the axis. |
void |
setNumber(int number)
Sets the format index for the TickLabels object. |
void |
setNumberFormat(java.lang.String format)
Sets the format string for the TickLabels object. |
void |
setNumberFormatLinked(boolean linked)
Sets if the number format is linked to the cells(so that the number format changes in the labels when it changes in the cells). |
void |
setRotation(int rotation)
Sets text rotation angle.Must be between -90 and 90. |
void |
setTextDirection(int directionType)
Sets the text direction type. |
void |
setTickLabelPosition(int tickLabelPosition)
Sets the position of tick-mark labels on the axis. |
void |
setVisible(boolean isVisible)
Sets whether the axis is visible. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public DisplayUnitLabel getDisplayUnitLabel()
public byte getDisplayUnitType()
public void setDisplayUnitType(byte displayUnitType)
displayUnitType
- It must be one of the following values:
DisplayUnitType.NONE |
DisplayUnitType.HUNDREDS |
DisplayUnitType.THOUSANDS |
DisplayUnitType.MILLIONS |
DisplayUnitType.BILLIONS |
DisplayUnitType.TRILLIONS |
public boolean isDisplayUnitLabelShown()
public void setDisplayUnitLabelShown(boolean isShown)
isShown
- if the display unit label is shown on the specified axispublic Line getAxisLine()
CellsException
- if chart has bean removed.public void setAxisLine(Line line)
line
- the appearance of an axis.
CellsException
- if chart has bean removed.public Area getArea()
public Line getMajorGridLines()
CellsException
- if chart has bean removed.public Line getMinorGridLines()
CellsException
- if chart has bean removed.public Font getFont()
CellsException
- if chart has bean removed.public void setFont(Font font)
font
- a Font object.
CellsException
- if chart has bean removed.public boolean isAutoScaleFont()
public void setAutoScaleFont(boolean isAutoScaleFont)
isAutoScaleFont
- whether the text in the object changes font size when the object size changespublic 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 int getNumber()
CellsException
- if chart has bean removed.Style.setNumber(int)
public void setNumber(int number)
number
- the format index.
CellsException
- if chart has bean removed.Style.setNumber(int)
public boolean isNumberFormatLinked()
public void setNumberFormatLinked(boolean linked)
linked
- if the number format is linked to the cellspublic java.lang.String getNumberFormat()
public void setNumberFormat(java.lang.String format)
format
- the format string for the TickLabels object.public int getRotation()
CellsException
- if chart has bean removed.public void setRotation(int rotation)
rotation
- text rotation angle.
java.lang.IllegalArgumentException
- if rotation is not between -90 and 90.
CellsException
- if chart has bean removed.public int getMajorTickMark()
CellsException
- if chart has bean removed.setMajorTickMark(int)
public void setMajorTickMark(int majorTickMark)
majorTickMark
- the type of major tick mark for the axis.
It could be one of the following values: TickMarkerType.CROSS |
TickMarkerType.INSIDE |
TickMarkerType.NONE |
TickMarkerType.OUTSIDE |
java.lang.IllegalArgumentException
- if majorTickMark is invalid tick mark type.
CellsException
- if chart has bean removed.public int getMinorTickMark()
CellsException
- if chart has bean removed.setMajorTickMark(int)
public void setMinorTickMark(int minorTickMark)
minorTickMark
- the type of minor tick mark for the axis.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if minorTickMark is invalid tick mark type.setMajorTickMark(int)
public int getTickLabelPosition()
CellsException
- if chart has bean removed.setTickLabelPosition(int)
public void setTickLabelPosition(int tickLabelPosition)
tickLabelPosition
- the position of tick-mark labels on the axis.
* It could be one of the following values: TickLabelPositionType.HIGH |
TickLabelPositionType.LOW |
TickLabelPositionType.NEXT_TO_AXIS |
TickLabelPositionType.NONE |
java.lang.IllegalArgumentException
- if tick label position type is invalid.
CellsException
- if chart has bean removed.public int getTextDirection()
TextDirectionType
public void setTextDirection(int directionType)
directionType
- the direction type. * It must be one of the following values:
TextDirectionType.CONTEXT |
TextDirectionType.LEFT_TO_RIGHT |
TextDirectionType.RIGHT_TO_LEFT |
java.lang.IllegalArgumentException
- if the direction type is invalid.TextDirectionType
public boolean isVisible()
CellsException
- if chart has bean removed.public void setVisible(boolean isVisible)
isVisible
- whether the axis is visible.
CellsException
- if chart has bean removed.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |