Axis (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.Axis

public class Axis
extends java.lang.Object

Encapsulates the object that represents an axis of chart.

Example

From the following codes , you can learn how to set unit, maximum and minimum value of Axis.

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Excel object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a sample value to "A1" cell
         worksheet.getCells().get("A1").putValue(50);
         //Adding a sample value to "A2" cell
         worksheet.getCells().get("A2").putValue(100);
         //Adding a sample value to "A3" cell
         worksheet.getCells().get("A3").putValue(150);
         //Adding a sample value to "B1" cell
         worksheet.getCells().get("B1").putValue(4);
         //Adding a sample value to "B2" cell
         worksheet.getCells().get("B2").putValue(20);
         //Adding a sample value to "B3" cell
         worksheet.getCells().get("B3").putValue(50);
         //Adding a chart to the worksheet
         int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 25, 5);
         //Accessing the instance of the newly added chart
         Chart chart = worksheet.getCharts().get(chartIndex);
         //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
         chart.getNSeries().add("A1:B3", true);
         //Set the max value of value axis
         chart.getValueAxis().setMaxValue(200);
         //Set the min value of value axis
         chart.getValueAxis().setMinValue(0);
         //Set the major unit
         chart.getValueAxis().setMajorUnit(25);
         //Category(X) axis crosses at the maxinum value.
         chart.getValueAxis().setCrossType(CrossType.MAXIMUM);
         //Set he number of categories or series between tick-mark labels. 
         chart.getCategoryAxis().setTickLabelSpacing(2);
 
         //do your business
 
         //Saving the Excel file
         workbook.save("book1.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`Area`	`getArea()` Gets the `Area`.
`boolean`	`getAxisBetweenCategories()` Represents if the value axis crosses the category axis between categories.
`java.util.ArrayList`	`getAxisLabels()` Deprecated. Use Axis.GetAxisTexts method, instead.
`Line`	`getAxisLine()` Gets the appearance of an Axis.
`java.lang.String[]`	`getAxisTexts()` Gets the labels of the axis after call Chart.Calculate() method.
`int`	`getBaseUnitScale()` Represents the base unit scale for the category axis.
`AxisBins`	`getBins()` Represents bins on a chart(Histogram/Pareto) axis
`int`	`getCategoryType()` Represents the category axis type.
`double`	`getCrossAt()` Represents the point on the value axis where the category axis crosses it.
`int`	`getCrossType()` Represents the `getCrossType()` on the specified axis where the other axis crosses.
`double`	`getCustomDisplayUnit()` Specifies a custom value for the display unit.
`int`	`getCustomUnit()` Deprecated. Use Axis.CustomDisplayUnit property, instead.
`int`	`getCustUnit()` Deprecated. Use Axis.CustomUnit property, instead.
`int`	`getDisplayUnit()` Represents the unit label for the specified axis.
`DisplayUnitLabel`	`getDisplayUnitLabel()` Represents a unit label on an axis in the specified chart.
`double`	`getLogBase()` Represents the logarithmic base.
`Line`	`getMajorGridLines()` Represents major gridlines on a chart axis.
`int`	`getMajorTickMark()` Represents the type of major tick mark for the specified axis.
`double`	`getMajorUnit()` Represents the major units for the axis.
`int`	`getMajorUnitScale()` Represents the major unit scale for the category axis.
`java.lang.Object`	`getMaxValue()` Represents the maximum value on the value axis.
`Line`	`getMinorGridLines()` Represents minor gridlines on a chart axis.
`int`	`getMinorTickMark()` Represents the type of minor tick mark for the specified axis.
`double`	`getMinorUnit()` Represents the minor units for the axis.
`int`	`getMinorUnitScale()` Represents the major unit scale for the category axis.
`java.lang.Object`	`getMinValue()` Represents the minimum value on the value axis.
`int`	`getTickLabelPosition()` Represents the position of tick-mark labels on the specified axis.
`TickLabels`	`getTickLabels()` Returns a `getTickLabels()` object that represents the tick-mark labels for the specified axis.
`int`	`getTickLabelSpacing()` Represents the number of categories or series between tick-mark labels.
`int`	`getTickMarkSpacing()` Returns or sets the number of categories or series between tick marks.
`Title`	`getTitle()` Gets the axis' title.
`boolean`	`hasMultiLevelLabels()` Indicates whether the labels shall be shown as multi level.
`boolean`	`isAutomaticMajorUnit()` Indicates whether the major unit of the axis is automatically assigned.
`boolean`	`isAutomaticMaxValue()` Indicates whether the max value is automatically assigned.
`boolean`	`isAutomaticMinorUnit()` Indicates whether the minor unit of the axis is automatically assigned.
`boolean`	`isAutomaticMinValue()` Indicates whether the min value is automatically assigned.
`boolean`	`isAutoTickLabelSpacing()` Indicates whether the spacing of tick label is automatic
`boolean`	`isBaseUnitAuto()` Represents whether the base unit is automatic.
`boolean`	`isDisplayUnitLabelShown()` Represents if the display unit label is shown on the specified axis.
`boolean`	`isLogarithmic()` Represents if the value axis scale type is logarithmic or not.
`boolean`	`isPlotOrderReversed()` Represents if Microsoft Excel plots data points from last to first.
`boolean`	`isVisible()` Represents if the axis is visible.
`void`	`setAutomaticMajorUnit(boolean value)` Indicates whether the major unit of the axis is automatically assigned.
`void`	`setAutomaticMaxValue(boolean value)` Indicates whether the max value is automatically assigned.
`void`	`setAutomaticMinorUnit(boolean value)` Indicates whether the minor unit of the axis is automatically assigned.
`void`	`setAutomaticMinValue(boolean value)` Indicates whether the min value is automatically assigned.
`void`	`setAutoTickLabelSpacing(boolean value)` Indicates whether the spacing of tick label is automatic
`void`	`setAxisBetweenCategories(boolean value)` Represents if the value axis crosses the category axis between categories.
`void`	`setBaseUnitAuto(boolean value)` Represents whether the base unit is automatic.
`void`	`setBaseUnitScale(int value)` Represents the base unit scale for the category axis.
`void`	`setCategoryType(int value)` Represents the category axis type.
`void`	`setCrossAt(double value)` Represents the point on the value axis where the category axis crosses it.
`void`	`setCrossType(int value)` Represents the `getCrossType()` on the specified axis where the other axis crosses.
`void`	`setCustomDisplayUnit(double value)` Specifies a custom value for the display unit.
`void`	`setCustomUnit(int value)` Deprecated. Use Axis.CustomDisplayUnit property, instead.
`void`	`setCustUnit(int value)` Deprecated. Use Axis.CustomUnit property, instead.
`void`	`setDisplayUnit(int value)` Represents the unit label for the specified axis.
`void`	`setDisplayUnitLabelShown(boolean value)` Represents if the display unit label is shown on the specified axis.
`void`	`setHasMultiLevelLabels(boolean value)` Indicates whether the labels shall be shown as multi level.
`void`	`setLogarithmic(boolean value)` Represents if the value axis scale type is logarithmic or not.
`void`	`setLogBase(double value)` Represents the logarithmic base.
`void`	`setMajorTickMark(int value)` Represents the type of major tick mark for the specified axis.
`void`	`setMajorUnit(double value)` Represents the major units for the axis.
`void`	`setMajorUnitScale(int value)` Represents the major unit scale for the category axis.
`void`	`setMaxValue(java.lang.Object value)` Represents the maximum value on the value axis.
`void`	`setMinorTickMark(int value)` Represents the type of minor tick mark for the specified axis.
`void`	`setMinorUnit(double value)` Represents the minor units for the axis.
`void`	`setMinorUnitScale(int value)` Represents the major unit scale for the category axis.
`void`	`setMinValue(java.lang.Object value)` Represents the minimum value on the value axis.
`void`	`setPlotOrderReversed(boolean value)` Represents if Microsoft Excel plots data points from last to first.
`void`	`setTickLabelPosition(int value)` Represents the position of tick-mark labels on the specified axis.
`void`	`setTickLabelSpacing(int value)` Represents the number of categories or series between tick-mark labels.
`void`	`setTickMarkSpacing(int value)` Returns or sets the number of categories or series between tick marks.
`void`	`setVisible(boolean value)` Represents if the axis is visible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getArea
```
public Area getArea()
```
    Gets the Area.
  - isAutomaticMinValue
```
public boolean isAutomaticMinValue()
```
    Indicates whether the min value is automatically assigned.
  - setAutomaticMinValue
```
public void setAutomaticMinValue(boolean value)
```
    Indicates whether the min value is automatically assigned.
  - getMinValue
```
public java.lang.Object getMinValue()
```
    Represents the minimum value on the value axis.
    Remarks
    The minValue type only can be double or DateTime
  - setMinValue
```
public void setMinValue(java.lang.Object value)
```
    Represents the minimum value on the value axis.
    Remarks
    The minValue type only can be double or DateTime
  - isAutomaticMaxValue
```
public boolean isAutomaticMaxValue()
```
    Indicates whether the max value is automatically assigned.
  - setAutomaticMaxValue
```
public void setAutomaticMaxValue(boolean value)
```
    Indicates whether the max value is automatically assigned.
  - getMaxValue
```
public java.lang.Object getMaxValue()
```
    Represents the maximum value on the value axis.
    Remarks
    The maxValue type only can be double or DateTime
  - setMaxValue
```
public void setMaxValue(java.lang.Object value)
```
    Represents the maximum value on the value axis.
    Remarks
    The maxValue type only can be double or DateTime
  - isAutomaticMajorUnit
```
public boolean isAutomaticMajorUnit()
```
    Indicates whether the major unit of the axis is automatically assigned.
  - setAutomaticMajorUnit
```
public void setAutomaticMajorUnit(boolean value)
```
    Indicates whether the major unit of the axis is automatically assigned.
  - getMajorUnit
```
public double getMajorUnit()
```
    Represents the major units for the axis.
    Remarks
    The major units must be greater than zero.
  - setMajorUnit
```
public void setMajorUnit(double value)
```
    Represents the major units for the axis.
    Remarks
    The major units must be greater than zero.
  - isAutomaticMinorUnit
```
public boolean isAutomaticMinorUnit()
```
    Indicates whether the minor unit of the axis is automatically assigned.
  - setAutomaticMinorUnit
```
public void setAutomaticMinorUnit(boolean value)
```
    Indicates whether the minor unit of the axis is automatically assigned.
  - getMinorUnit
```
public double getMinorUnit()
```
    Represents the minor units for the axis.
    Remarks
    The minor units must be greater than zero.
  - setMinorUnit
```
public void setMinorUnit(double value)
```
    Represents the minor units for the axis.
    Remarks
    The minor units must be greater than zero.
  - getAxisLine
```
public Line getAxisLine()
```
    Gets the appearance of an Axis.
  - getMajorTickMark
```
public int getMajorTickMark()
```
    Represents the type of major tick mark for the specified axis.
    See TickMarkType.
  - setMajorTickMark
```
public void setMajorTickMark(int value)
```
    Represents the type of major tick mark for the specified axis.
    See TickMarkType.
  - getMinorTickMark
```
public int getMinorTickMark()
```
    Represents the type of minor tick mark for the specified axis.
    See TickMarkType.
  - setMinorTickMark
```
public void setMinorTickMark(int value)
```
    Represents the type of minor tick mark for the specified axis.
    See TickMarkType.
  - getTickLabelPosition
```
public int getTickLabelPosition()
```
    Represents the position of tick-mark labels on the specified axis.
    See TickLabelPositionType.
  - setTickLabelPosition
```
public void setTickLabelPosition(int value)
```
    Represents the position of tick-mark labels on the specified axis.
    See TickLabelPositionType.
  - getCrossAt
```
public double getCrossAt()
```
    Represents the point on the value axis where the category axis crosses it.
    Remarks
    The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
  - setCrossAt
```
public void setCrossAt(double value)
```
    Represents the point on the value axis where the category axis crosses it.
    Remarks
    The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
  - getCrossType
```
public int getCrossType()
```
    Represents the getCrossType() on the specified axis where the other axis crosses.
    See getCrossType().
  - setCrossType
```
public void setCrossType(int value)
```
    Represents the getCrossType() on the specified axis where the other axis crosses.
    See getCrossType().
  - getLogBase
```
public double getLogBase()
```
    Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
  - setLogBase
```
public void setLogBase(double value)
```
    Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
  - isLogarithmic
```
public boolean isLogarithmic()
```
    Represents if the value axis scale type is logarithmic or not.
  - setLogarithmic
```
public void setLogarithmic(boolean value)
```
    Represents if the value axis scale type is logarithmic or not.
  - isPlotOrderReversed
```
public boolean isPlotOrderReversed()
```
    Represents if Microsoft Excel plots data points from last to first.
  - setPlotOrderReversed
```
public void setPlotOrderReversed(boolean value)
```
    Represents if Microsoft Excel plots data points from last to first.
  - getAxisBetweenCategories
```
public boolean getAxisBetweenCategories()
```
    Represents if the value axis crosses the category axis between categories.
    Remarks
    This property applies only to category axes, and it doesn't apply to 3-D charts.
  - setAxisBetweenCategories
```
public void setAxisBetweenCategories(boolean value)
```
    Represents if the value axis crosses the category axis between categories.
    Remarks
    This property applies only to category axes, and it doesn't apply to 3-D charts.
  - getTickLabels
```
public TickLabels getTickLabels()
```
    Returns a getTickLabels() object that represents the tick-mark labels for the specified axis.
  - getTickLabelSpacing
```
public int getTickLabelSpacing()
```
    Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
    Remarks
    The number must be between 1 and 31999.
  - setTickLabelSpacing
```
public void setTickLabelSpacing(int value)
```
    Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
    Remarks
    The number must be between 1 and 31999.
  - isAutoTickLabelSpacing
```
public boolean isAutoTickLabelSpacing()
```
    Indicates whether the spacing of tick label is automatic
  - setAutoTickLabelSpacing
```
public void setAutoTickLabelSpacing(boolean value)
```
    Indicates whether the spacing of tick label is automatic
  - getTickMarkSpacing
```
public int getTickMarkSpacing()
```
    Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
    Remarks
    The number must be between 1 and 31999.
  - setTickMarkSpacing
```
public void setTickMarkSpacing(int value)
```
    Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
    Remarks
    The number must be between 1 and 31999.
  - getDisplayUnit
```
public int getDisplayUnit()
```
    Represents the unit label for the specified axis.
    See DisplayUnitType.
  - setDisplayUnit
```
public void setDisplayUnit(int value)
```
    Represents the unit label for the specified axis.
    See DisplayUnitType.
  - getCustUnit
```
public int getCustUnit()
```
    Deprecated. Use Axis.CustomUnit property, instead.
    
    Specifies a custom value for the display unit.
    Remarks
    NOTE: This property is now obsolete. Instead, please use Axis.CustomUnit property. This property will be removed 12 months later since January 2023. Aspose apologizes for any inconvenience you may have experienced.
  - setCustUnit
```
public void setCustUnit(int value)
```
    Deprecated. Use Axis.CustomUnit property, instead.
    
    Specifies a custom value for the display unit.
    Remarks
    NOTE: This property is now obsolete. Instead, please use Axis.CustomUnit property. This property will be removed 12 months later since January 2023. Aspose apologizes for any inconvenience you may have experienced.
  - getCustomUnit
```
public int getCustomUnit()
```
    Deprecated. Use Axis.CustomDisplayUnit property, instead.
    
    Specifies a custom value for the display unit.
    Remarks
    NOTE: This property is now obsolete. Instead, please use Axis.CustomDisplayUnit property. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
  - setCustomUnit
```
public void setCustomUnit(int value)
```
    Deprecated. Use Axis.CustomDisplayUnit property, instead.
    
    Specifies a custom value for the display unit.
    Remarks
    NOTE: This property is now obsolete. Instead, please use Axis.CustomDisplayUnit property. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
  - getCustomDisplayUnit
```
public double getCustomDisplayUnit()
```
    Specifies a custom value for the display unit.
  - setCustomDisplayUnit
```
public void setCustomDisplayUnit(double value)
```
    Specifies a custom value for the display unit.
  - getDisplayUnitLabel
```
public DisplayUnitLabel getDisplayUnitLabel()
```
    Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values鈥?for example, in the millions or billions.
  - isDisplayUnitLabelShown
```
public boolean isDisplayUnitLabelShown()
```
    Represents if the display unit label is shown on the specified axis.
    Remarks
    The default value is True.
  - setDisplayUnitLabelShown
```
public void setDisplayUnitLabelShown(boolean value)
```
    Represents if the display unit label is shown on the specified axis.
    Remarks
    The default value is True.
  - getTitle
```
public Title getTitle()
```
    Gets the axis' title.
  - getCategoryType
```
public int getCategoryType()
```
    Represents the category axis type.
    See CategoryType.
  - setCategoryType
```
public void setCategoryType(int value)
```
    Represents the category axis type.
    See CategoryType.
  - getBaseUnitScale
```
public int getBaseUnitScale()
```
    Represents the base unit scale for the category axis.
    See TimeUnit.
    
    Remarks
    Setting this property only takes effect when the CategoryType property is set to TimeScale.
  - setBaseUnitScale
```
public void setBaseUnitScale(int value)
```
    Represents the base unit scale for the category axis.
    See TimeUnit.
    
    Remarks
    Setting this property only takes effect when the CategoryType property is set to TimeScale.
  - isBaseUnitAuto
```
public boolean isBaseUnitAuto()
```
    Represents whether the base unit is automatic.
  - setBaseUnitAuto
```
public void setBaseUnitAuto(boolean value)
```
    Represents whether the base unit is automatic.
  - getMajorUnitScale
```
public int getMajorUnitScale()
```
    Represents the major unit scale for the category axis.
    See TimeUnit.
    
    Example
```
 
         chart.getCategoryAxis().setCategoryType(CategoryType.TIME_SCALE);
         chart.getCategoryAxis().setMajorUnitScale(TimeUnit.MONTHS);
         chart.getCategoryAxis().setMajorUnit(2);
 
```
  - setMajorUnitScale
```
public void setMajorUnitScale(int value)
```
    Represents the major unit scale for the category axis.
    See TimeUnit.
  - getMinorUnitScale
```
public int getMinorUnitScale()
```
    Represents the major unit scale for the category axis.
    See TimeUnit.
    
    Example
```
 
         chart.getCategoryAxis().setCategoryType(CategoryType.TIME_SCALE);
         chart.getCategoryAxis().setMinorUnitScale(TimeUnit.MONTHS);
         chart.getCategoryAxis().setMinorUnit(2);
 
```
  - setMinorUnitScale
```
public void setMinorUnitScale(int value)
```
    Represents the major unit scale for the category axis.
    See TimeUnit.
  - isVisible
```
public boolean isVisible()
```
    Represents if the axis is visible.
  - setVisible
```
public void setVisible(boolean value)
```
    Represents if the axis is visible.
  - getMajorGridLines
```
public Line getMajorGridLines()
```
    Represents major gridlines on a chart axis.
    Example
```
 
         chart.getValueAxis().getMajorGridLines().setVisible(false);
         chart.getCategoryAxis().getMajorGridLines().setVisible(true);
 
```
  - getMinorGridLines
```
public Line getMinorGridLines()
```
    Represents minor gridlines on a chart axis.
  - hasMultiLevelLabels
```
public boolean hasMultiLevelLabels()
```
    Indicates whether the labels shall be shown as multi level.
    Remarks
    Only valid for category axis.
  - setHasMultiLevelLabels
```
public void setHasMultiLevelLabels(boolean value)
```
    Indicates whether the labels shall be shown as multi level.
    Remarks
    Only valid for category axis.
  - getAxisTexts
```
public java.lang.String[] getAxisTexts()
```
    Gets the labels of the axis after call Chart.Calculate() method.
  - getAxisLabels
```
public java.util.ArrayList getAxisLabels()
```
    Deprecated. Use Axis.GetAxisTexts method, instead.
    
    Gets the labels of the axis after call Chart.Calculate() method.
    Remarks
    NOTE: This member is now obsolete. Instead, please use Axis.GetAxisTexts method. This property will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
  - getBins
```
public AxisBins getBins()
```
    Represents bins on a chart(Histogram/Pareto) axis

Class Axis

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getArea

isAutomaticMinValue

setAutomaticMinValue

getMinValue

setMinValue

isAutomaticMaxValue

setAutomaticMaxValue

getMaxValue

setMaxValue

isAutomaticMajorUnit

setAutomaticMajorUnit

getMajorUnit

setMajorUnit

isAutomaticMinorUnit

setAutomaticMinorUnit

getMinorUnit

setMinorUnit

getAxisLine

getMajorTickMark

setMajorTickMark

getMinorTickMark

setMinorTickMark

getTickLabelPosition

setTickLabelPosition

getCrossAt

setCrossAt

getCrossType

setCrossType

getLogBase

setLogBase

isLogarithmic

setLogarithmic

isPlotOrderReversed

setPlotOrderReversed

getAxisBetweenCategories

setAxisBetweenCategories

getTickLabels

getTickLabelSpacing

setTickLabelSpacing

isAutoTickLabelSpacing

setAutoTickLabelSpacing

getTickMarkSpacing

setTickMarkSpacing

getDisplayUnit

setDisplayUnit

getCustUnit

setCustUnit

getCustomUnit

setCustomUnit

getCustomDisplayUnit

setCustomDisplayUnit

getDisplayUnitLabel

isDisplayUnitLabelShown

setDisplayUnitLabelShown

getTitle

getCategoryType

setCategoryType

getBaseUnitScale

setBaseUnitScale

isBaseUnitAuto

setBaseUnitAuto

getMajorUnitScale

setMajorUnitScale

getMinorUnitScale

setMinorUnitScale

isVisible

setVisible

getMajorGridLines

getMinorGridLines

hasMultiLevelLabels

setHasMultiLevelLabels

getAxisTexts

getAxisLabels

getBins