Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class ValueAxis

java.lang.Object
  extended by com.aspose.cells.Axis
      extended by com.aspose.cells.ValueAxis
All Implemented Interfaces:
java.lang.Cloneable

public class ValueAxis
extends Axis

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


Method Summary
 double getCrossAt()
          Gets the point on the value axis where the other axis crosses.
 float getLogarithmicBase()
          Gets the base of logarithmic scale.
 double getMajorUnit()
          Gets the major units for the value axis.
 double getMaxValue()
          Gets the maximum value on the value axis.
 double getMinorUnit()
          Gets the minor units for the value axis.
 double getMinValue()
          Gets the minimum value on the value axis.
 Title getTitle()
          Gets the value axis' title.
 boolean isAutoCross()
          Indicates whether Microsoft Workbook automatically sets the axis crossing point.
 boolean isAutoMajorUnit()
          Indicates whether Microsoft Workbook automatically sets the major unit.
 boolean isAutoMax()
          Indicates whether Microsoft Workbook automatically sets the max value.
 boolean isAutoMin()
          Indicates whether Microsoft Workbook automatically sets the min value.
 boolean isAutoMinorUnit()
          Indicates whether Microsoft Workbook automatically sets the minor unit.
 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.
 void setAutoCross(boolean isAutoCross)
          Sets whether Microsoft Workbook automatically sets the axis crossing point.
 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 setLogarithmic(boolean isLogarithmic)
          Sets whether the value axis scale type is logarithmic or not.
 void setLogarithmicBase(float base)
          Sets the base of logarithmic scale.
 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 setMinorUnit(double minorUnit)
          Sets the minor units for the value axis.
 void setMinValue(double minValue)
          Sets the minimum value on the value axis.
 void setPlotOrderReversed(boolean isPlotOrderReversed)
          Sets whether Microsoft Workbook plots data points from last to first.
 
Methods inherited from class com.aspose.cells.Axis
getArea, getAxisLine, getBackgroundMode, getDisplayUnitLabel, getDisplayUnitType, getFont, getMajorGridLines, getMajorTickMark, getMinorGridLines, getMinorTickMark, getNumber, getNumberFormat, getRotation, getTextDirection, getTickLabelPosition, isAutoScaleFont, isDisplayUnitLabelShown, isNumberFormatLinked, isVisible, setAutoScaleFont, setAxisLine, setBackgroundMode, setDisplayUnitLabelShown, setDisplayUnitType, setFont, setMajorTickMark, setMinorTickMark, setNumber, setNumberFormat, setNumberFormatLinked, setRotation, setTextDirection, setTickLabelPosition, setVisible
 
Methods inherited from class java.lang.Object
equals, 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.

getLogarithmicBase

public float getLogarithmicBase()
Gets the base of logarithmic scale.

Returns:
the base of logarithmic scale.

setLogarithmicBase

public void setLogarithmicBase(float base)
Sets the base of logarithmic scale.

Parameters:
base - the base of logarithmic scale. Can only be between 2 and 1000.

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.

isAutoMin

public boolean isAutoMin()
Indicates whether Microsoft Workbook automatically sets the min value.

Returns:
true the min value is auto; false the min value is user customed.

isAutoMax

public boolean isAutoMax()
Indicates whether Microsoft Workbook automatically sets the max value.

Returns:
true the max value is auto; false the max value is user customed.

isAutoMajorUnit

public boolean isAutoMajorUnit()
Indicates whether Microsoft Workbook automatically sets the major unit.

Returns:
true the major unit is auto; false the major unit is user customed.

isAutoMinorUnit

public boolean isAutoMinorUnit()
Indicates whether Microsoft Workbook automatically sets the minor unit.

Returns:
true the minor unit is auto; false the minor unit is user customed.