Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class ValueAxis

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

public class ValueAxis
extends java.lang.Object

Encapsulates the object that represents a chart's value axis.


Method Summary
 Line getAxisLine()
          Gets the appearance of an axis.
 double getCrossAt()
          Gets the point on the value axis where the other axis crosses.
 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.
 double getMajorUnit()
          Gets the major units for the value axis.
 double getMaxValue()
          Gets the maximum value on the value axis.
 Line getMinorGridLines()
          Gets minor gridlines on a chart axis.
 int getMinorTickMark()
          Gets the type of minor tick mark for the axis.
 double getMinorUnit()
          Gets the minor units for the value axis.
 double getMinValue()
          Gets the minimum value on the value axis.
 int getNumber()
          Gets the format index for the TickLabels object.
 int getRotation()
          Gets text rotation angle.
 int getTickLabelPosition()
          Gets the position of tick-mark labels on the axis.
 Title getTitle()
          Gets the value axis' title.
 boolean isAutoCross()
          Indicates whether Microsoft Workbook automatically sets the axis crossing point.
 boolean isCrossAtMax()
          Indicates whether the axis crosses at the maximum value.
 boolean isLogarithmic()
          Indicates whether the value axis scale type is logarithmic or not.
 boolean isPlotOrderReversed()
          Indicates whether Microsoft Workbook plots data points from last to first.
 boolean isVisible()
          Indicates whether the axis is visible.
 void setAutoCross(boolean isAutoCross)
          Sets whether Microsoft Workbook automatically sets the axis crossing point.
 void setAxisLine(Line line)
          Sets the appearance of an axis.
 void setCrossAt(double crossAt)
          Sets the point on the value axis where the other axis crosses.
 void setCrossAtMax(boolean isCrossAtMax)
          Sets whether the axis crosses at the maximum value.
 void setFont(Font font)
          Sets a Font object that represents the font of the specified TickLabels object.
 void setLogarithmic(boolean isLogarithmic)
          Sets whether the value axis scale type is logarithmic or not.
 void setMajorTickMark(int majorTickMark)
          Sets the type of major tick mark for the axis.
 void setMajorUnit(double majorUnit)
          Sets the major units for the value axis.
 void setMaxValue(double maxValue)
          Sets the maximum value on the value axis.
 void setMinorTickMark(int minorTickMark)
          Sets the type of minor tick mark for the axis.
 void setMinorUnit(double minorUnit)
          Sets the minor units for the value axis.
 void setMinValue(double minValue)
          Sets the minimum value on the value axis.
 void setNumber(int number)
          Sets the format index for the TickLabels object.
 void setPlotOrderReversed(boolean isPlotOrderReversed)
          Sets whether Microsoft Workbook plots data points from last to first.
 void setRotation(int rotation)
          Sets text rotation angle.Must be between -90 and 90.
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTitle

public Title getTitle()
Gets the value axis' title.

Returns:
Gets the value axis' title.
Throws:
CellsException - if chart has bean removed.

getCrossAt

public double getCrossAt()
Gets the point on the value axis where the other axis crosses.

Returns:
the point on the value axis where the other axis crosses.
Throws:
CellsException - if chart has bean removed.

setCrossAt

public void setCrossAt(double crossAt)
Sets the point on the value axis where the other axis crosses.

Parameters:
crossAt - the point on the value axis where the other axis crosses.
Throws:
CellsException - if chart has bean removed.

getMajorUnit

public double getMajorUnit()
Gets the major units for the value axis.

Returns:
the major units for the value axis.
Throws:
CellsException - if chart has bean removed.

setMajorUnit

public void setMajorUnit(double majorUnit)
Sets the major units for the value axis.

Parameters:
majorUnit - the major units for the value axis.
Throws:
CellsException - if chart has bean removed.

getMinorUnit

public double getMinorUnit()
Gets the minor units for the value axis.

Returns:
the minor units for the value axis.
Throws:
CellsException - if chart has bean removed.

setMinorUnit

public void setMinorUnit(double minorUnit)
Sets the minor units for the value axis.

Parameters:
minorUnit - the minor units for the value axis.
Throws:
CellsException - if chart has bean removed.

getMaxValue

public double getMaxValue()
Gets the maximum value on the value axis.

Returns:
the maximum value on the value axis.
Throws:
CellsException - if chart has bean removed.

setMaxValue

public void setMaxValue(double maxValue)
Sets the maximum value on the value axis.

Parameters:
maxValue - the maximum value on the value axis.
Throws:
CellsException - if chart has bean removed.

getMinValue

public double getMinValue()
Gets the minimum value on the value axis.

Returns:
the minimum value on the value axis.
Throws:
CellsException - if chart has bean removed.

setMinValue

public void setMinValue(double minValue)
Sets the minimum value on the value axis.

Parameters:
minValue - the minimum value on the value axis.
Throws:
CellsException - if chart has bean removed.

setCrossAtMax

public void setCrossAtMax(boolean isCrossAtMax)
Sets whether the axis crosses at the maximum value.

Parameters:
isCrossAtMax - whether the axis crosses at the maximum value.
Throws:
CellsException - if chart has bean removed.

isCrossAtMax

public boolean isCrossAtMax()
Indicates whether the axis crosses at the maximum value.

Returns:
whether the axis crosses at the maximum value.
Throws:
CellsException - if chart has bean removed.

setPlotOrderReversed

public void setPlotOrderReversed(boolean isPlotOrderReversed)
Sets whether Microsoft Workbook plots data points from last to first.

Parameters:
isPlotOrderReversed - whether Microsoft Workbook plots data points from last to first.
Throws:
CellsException - if chart has bean removed.

isPlotOrderReversed

public boolean isPlotOrderReversed()
Indicates whether Microsoft Workbook plots data points from last to first.

Returns:
whether Microsoft Workbook plots data points from last to first.
Throws:
CellsException - if chart has bean removed.

setLogarithmic

public void setLogarithmic(boolean isLogarithmic)
Sets whether the value axis scale type is logarithmic or not.

Parameters:
isLogarithmic - whether the value axis scale type is logarithmic or not.
Throws:
CellsException - if chart has bean removed.

isLogarithmic

public boolean isLogarithmic()
Indicates whether the value axis scale type is logarithmic or not.

Returns:
whether the value axis scale type is logarithmic or not.
Throws:
CellsException - if chart has bean removed.

isAutoCross

public boolean isAutoCross()
Indicates whether Microsoft Workbook automatically sets the axis crossing point.

Returns:
whether Microsoft Workbook automatically sets the axis crossing point.
Throws:
CellsException - if chart has bean removed.

setAutoCross

public void setAutoCross(boolean isAutoCross)
Sets whether Microsoft Workbook automatically sets the axis crossing point.

Parameters:
isAutoCross - whether Microsoft Workbook automatically sets the axis crossing point.
Throws:
CellsException - if chart has bean removed.

getAxisLine

public Line getAxisLine()
Gets the appearance of an axis.

Returns:
the appearance of an axis.
Throws:
CellsException - if chart has bean removed.

setAxisLine

public void setAxisLine(Line line)
Sets the appearance of an axis.

Parameters:
line - the appearance of an axis.
Throws:
CellsException - if chart has bean removed.

getMajorGridLines

public Line getMajorGridLines()
Gets major gridlines on a chart axis.

Returns:
major gridlines on a chart axis.
Throws:
CellsException - if chart has bean removed.

getMinorGridLines

public Line getMinorGridLines()
Gets minor gridlines on a chart axis.

Returns:
minor gridlines on a chart axis.
Throws:
CellsException - if chart has bean removed.

getFont

public Font getFont()
Gets a Font object that represents the font of the specified TickLabels object.

Returns:
a Font object.
Throws:
CellsException - if chart has bean removed.

setFont

public void setFont(Font font)
Sets a Font object that represents the font of the specified TickLabels object.

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

getNumber

public int getNumber()
Gets the format index for the TickLabels object.

Returns:
the format index
Throws:
CellsException - if chart has bean removed.
See Also:
Style.setNumber(int)

setNumber

public void setNumber(int number)
Sets the format index for the TickLabels object.

Parameters:
number - the format index.
Throws:
java.lang.IllegalArgumentException - if format number is not built-in number.
CellsException - if chart has bean removed.
See Also:
Style.setNumber(int)

getRotation

public int getRotation()
Gets text rotation angle.

Returns:
text rotation angle.
Throws:
CellsException - if chart has bean removed.

setRotation

public void setRotation(int rotation)
Sets text rotation angle.Must be between -90 and 90.

Parameters:
rotation - text rotation angle.
Throws:
java.lang.IllegalArgumentException - if rotation is not between -90 and 90.
CellsException - if chart has bean removed.

getMajorTickMark

public int getMajorTickMark()
Gets the type of major tick mark for the axis.

Returns:
the type of major tick mark for the axis.
Throws:
CellsException - if chart has bean removed.
See Also:
setMajorTickMark(int)

setMajorTickMark

public void setMajorTickMark(int majorTickMark)
Sets the type of major tick mark for the axis.

Parameters:
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
Throws:
java.lang.IllegalArgumentException - if majorTickMark is invalid tick mark type.
CellsException - if chart has bean removed.

getMinorTickMark

public int getMinorTickMark()
Gets the type of minor tick mark for the axis.

Returns:
the type of minor tick mark for the axis.
Throws:
CellsException - if chart has bean removed.
See Also:
setMajorTickMark(int)

setMinorTickMark

public void setMinorTickMark(int minorTickMark)
Sets the type of minor tick mark for the axis.

Parameters:
minorTickMark - the type of minor tick mark for the axis.
Throws:
CellsException - if chart has bean removed.
java.lang.IllegalArgumentException - if minorTickMark is invalid tick mark type.
See Also:
setMajorTickMark(int)

getTickLabelPosition

public int getTickLabelPosition()
Gets the position of tick-mark labels on the axis.

Returns:
the position of tick-mark labels on the axis.
Throws:
CellsException - if chart has bean removed.
See Also:
setTickLabelPosition(int)

setTickLabelPosition

public void setTickLabelPosition(int tickLabelPosition)
Sets the position of tick-mark labels on the axis.

Parameters:
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
Throws:
java.lang.IllegalArgumentException - if tick label position type is invalid.
CellsException - if chart has bean removed.

isVisible

public boolean isVisible()
Indicates whether the axis is visible.

Returns:
whether the axis is visible.
Throws:
CellsException - if chart has bean removed.

setVisible

public void setVisible(boolean isVisible)
Sets whether the axis is visible.

Parameters:
isVisible - whether the axis is visible.
Throws:
CellsException - if chart has bean removed.