ChartAxis (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.ChartAxis

All Implemented Interfaces:

java.lang.Cloneable
```
public class ChartAxis
extends java.lang.Object
implements java.lang.Cloneable
```
Represents the axis options of the chart.
To learn more, visit the Working with Charts documentation article.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAxisBetweenCategories()` Gets a flag indicating whether the value axis crosses the category axis between categories.
`int`	`getBaseTimeUnit()` Gets the smallest time unit that is represented on the time category axis.
`int`	`getCategoryType()` Gets type of the category axis.
`int`	`getCrosses()` Specifies how this axis crosses the perpendicular axis.
`double`	`getCrossesAt()` Specifies where on the perpendicular axis the axis crosses.
`AxisDisplayUnit`	`getDisplayUnit()` Specifies the scaling value of the display units for the value axis.
`DocumentBase`	`getDocument()` Returns the Document the title holder belongs.
`boolean`	`getHidden()` Gets a flag indicating whether this axis is hidden or not.
`int`	`getMajorTickMark()` Gets the major tick marks.
`double`	`getMajorUnit()` Gets the distance between major tick marks.
`boolean`	`getMajorUnitIsAuto()` Gets a flag indicating whether default distance between major tick marks shall be used.
`int`	`getMajorUnitScale()` Gets the scale value for major tick marks on the time category axis.
`int`	`getMinorTickMark()` Gets the minor tick marks for the axis.
`double`	`getMinorUnit()` Gets the distance between minor tick marks.
`boolean`	`getMinorUnitIsAuto()` Gets a flag indicating whether default distance between minor tick marks shall be used.
`int`	`getMinorUnitScale()` Gets the scale value for minor tick marks on the time category axis.
`ChartNumberFormat`	`getNumberFormat()` Returns a `ChartNumberFormat` object that allows defining number formats for the axis.
`boolean`	`getReverseOrder()` Gets a flag indicating whether values of axis should be displayed in reverse order, i.e.
`AxisScaling`	`getScaling()` Provides access to the scaling options of the axis.
`int`	`getTickLabelAlignment()` Gets text alignment of axis tick labels.
`int`	`getTickLabelOffset()` Gets the distance of labels from the axis.
`int`	`getTickLabelPosition()` Gets the position of the tick labels on the axis.
`int`	`getTickLabelSpacing()` Gets the interval, at which tick labels are drawn.
`boolean`	`getTickLabelSpacingIsAuto()` Gets a flag indicating whether automatic interval of drawing tick labels shall be used.
`int`	`getTickMarkSpacing()` Gets the interval, at which tick marks are drawn.
`ChartTitle`	`getTitle()`
`boolean`	`getTitleDeleted()`
`int`	`getTitlePosition()`
`int`	`getType()` Returns type of the axis.
`boolean`	`isInherited()`
`boolean`	`isVisible()`
`protected java.lang.Object`	`memberwiseClone()`
`void`	`setAxisBetweenCategories(boolean value)` Sets a flag indicating whether the value axis crosses the category axis between categories.
`void`	`setBaseTimeUnit(int value)` Sets the smallest time unit that is represented on the time category axis.
`void`	`setCategoryType(int value)` Sets type of the category axis.
`void`	`setCrosses(int value)` Specifies how this axis crosses the perpendicular axis.
`void`	`setCrossesAt(double value)` Specifies where on the perpendicular axis the axis crosses.
`void`	`setHidden(boolean value)` Sets a flag indicating whether this axis is hidden or not.
`void`	`setMajorTickMark(int value)` Sets the major tick marks.
`void`	`setMajorUnit(double value)` Sets the distance between major tick marks.
`void`	`setMajorUnitIsAuto(boolean value)` Sets a flag indicating whether default distance between major tick marks shall be used.
`void`	`setMajorUnitScale(int value)` Sets the scale value for major tick marks on the time category axis.
`void`	`setMinorTickMark(int value)` Sets the minor tick marks for the axis.
`void`	`setMinorUnit(double value)` Sets the distance between minor tick marks.
`void`	`setMinorUnitIsAuto(boolean value)` Sets a flag indicating whether default distance between minor tick marks shall be used.
`void`	`setMinorUnitScale(int value)` Sets the scale value for minor tick marks on the time category axis.
`void`	`setReverseOrder(boolean value)` Sets a flag indicating whether values of axis should be displayed in reverse order, i.e.
`void`	`setTickLabelAlignment(int value)` Sets text alignment of axis tick labels.
`void`	`setTickLabelOffset(int value)` Sets the distance of labels from the axis.
`void`	`setTickLabelPosition(int value)` Sets the position of the tick labels on the axis.
`void`	`setTickLabelSpacing(int value)` Sets the interval, at which tick labels are drawn.
`void`	`setTickLabelSpacingIsAuto(boolean value)` Sets a flag indicating whether automatic interval of drawing tick labels shall be used.
`void`	`setTickMarkSpacing(int value)` Sets the interval, at which tick marks are drawn.
`void`	`setTitle(ChartTitle value)`
`void`	`setTitleDeleted(boolean value)`

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

- Method Detail
  - getType
```
public int getType()
```
    Returns type of the axis.
    
    Returns:
    
    Type of the axis. The returned value is one of ChartAxisType constants.
  - getCategoryType
```
public int getCategoryType()
```
    Gets type of the category axis. Only text categories ( AxisCategoryType.CATEGORY) are allowed in MS Office 2016 new charts.
    
    Returns:
    
    Type of the category axis. The returned value is one of AxisCategoryType constants.
  - setCategoryType
```
public void setCategoryType(int value)
```
    Sets type of the category axis. Only text categories ( AxisCategoryType.CATEGORY) are allowed in MS Office 2016 new charts.
    
    Parameters:
    
    value - Type of the category axis. The value must be one of AxisCategoryType constants.
  - getCrosses
```
public int getCrosses()
```
    Specifies how this axis crosses the perpendicular axis.
    Default value is AxisCrosses.AUTOMATIC.
    
    The property is not supported by MS Office 2016 new charts.
    
    Returns:
    
    The corresponding int value. The returned value is one of AxisCrosses constants.
  - setCrosses
```
public void setCrosses(int value)
```
    Specifies how this axis crosses the perpendicular axis.
    Default value is AxisCrosses.AUTOMATIC.
    
    The property is not supported by MS Office 2016 new charts.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of AxisCrosses constants.
  - getCrossesAt
```
public double getCrossesAt()
```
    Specifies where on the perpendicular axis the axis crosses.
    The property has effect only if getCrosses() / setCrosses(int) are set to AxisCrosses.CUSTOM. It is not supported by MS Office 2016 new charts.
    
    The units are determined by the type of axis. When the axis is a value axis, the value of the property is a decimal number on the value axis. When the axis is a time category axis, the value is defined as an integer number of days relative to the base date (30/12/1899). For a text category axis, the value is an integer category number, starting with 1 as the first category.
    
    Returns:
    
    The corresponding double value.
  - setCrossesAt
```
public void setCrossesAt(double value)
```
    Specifies where on the perpendicular axis the axis crosses.
    The property has effect only if getCrosses() / setCrosses(int) are set to AxisCrosses.CUSTOM. It is not supported by MS Office 2016 new charts.
    
    The units are determined by the type of axis. When the axis is a value axis, the value of the property is a decimal number on the value axis. When the axis is a time category axis, the value is defined as an integer number of days relative to the base date (30/12/1899). For a text category axis, the value is an integer category number, starting with 1 as the first category.
    
    Parameters:
    
    value - The corresponding double value.
  - getReverseOrder
```
public boolean getReverseOrder()
```
    Gets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min. The property is not supported by MS Office 2016 new charts. Default value is false.
    
    Returns:
    
    A flag indicating whether values of axis should be displayed in reverse order, i.e.
  - setReverseOrder
```
public void setReverseOrder(boolean value)
```
    Sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min. The property is not supported by MS Office 2016 new charts. Default value is false.
    
    Parameters:
    
    value - A flag indicating whether values of axis should be displayed in reverse order, i.e.
  - getMajorTickMark
```
public int getMajorTickMark()
```
    Gets the major tick marks.
    
    Returns:
    
    The major tick marks. The returned value is one of AxisTickMark constants.
  - setMajorTickMark
```
public void setMajorTickMark(int value)
```
    Sets the major tick marks.
    
    Parameters:
    
    value - The major tick marks. The value must be one of AxisTickMark constants.
  - getMinorTickMark
```
public int getMinorTickMark()
```
    Gets the minor tick marks for the axis.
    
    Returns:
    
    The minor tick marks for the axis. The returned value is one of AxisTickMark constants.
  - setMinorTickMark
```
public void setMinorTickMark(int value)
```
    Sets the minor tick marks for the axis.
    
    Parameters:
    
    value - The minor tick marks for the axis. The value must be one of AxisTickMark constants.
  - getTickLabelPosition
```
public int getTickLabelPosition()
```
    Gets the position of the tick labels on the axis. The property is not supported by MS Office 2016 new charts.
    
    Returns:
    
    The position of the tick labels on the axis. The returned value is one of AxisTickLabelPosition constants.
  - setTickLabelPosition
```
public void setTickLabelPosition(int value)
```
    Sets the position of the tick labels on the axis. The property is not supported by MS Office 2016 new charts.
    
    Parameters:
    
    value - The position of the tick labels on the axis. The value must be one of AxisTickLabelPosition constants.
  - getMajorUnit
```
public double getMajorUnit()
```
    Gets the distance between major tick marks.
    Valid range of a value is greater than zero. The property has effect for time category and value axes.
    
    Setting this property sets the getMajorUnitIsAuto() / setMajorUnitIsAuto(boolean) property to false.
    
    Returns:
    
    The distance between major tick marks.
  - setMajorUnit
```
public void setMajorUnit(double value)
```
    Sets the distance between major tick marks.
    Valid range of a value is greater than zero. The property has effect for time category and value axes.
    
    Setting this property sets the getMajorUnitIsAuto() / setMajorUnitIsAuto(boolean) property to false.
    
    Parameters:
    
    value - The distance between major tick marks.
  - getMajorUnitIsAuto
```
public boolean getMajorUnitIsAuto()
```
    Gets a flag indicating whether default distance between major tick marks shall be used. The property has effect for time category and value axes.
    
    Returns:
    
    A flag indicating whether default distance between major tick marks shall be used.
  - setMajorUnitIsAuto
```
public void setMajorUnitIsAuto(boolean value)
```
    Sets a flag indicating whether default distance between major tick marks shall be used. The property has effect for time category and value axes.
    
    Parameters:
    
    value - A flag indicating whether default distance between major tick marks shall be used.
  - getMajorUnitScale
```
public int getMajorUnitScale()
```
    Gets the scale value for major tick marks on the time category axis. The property has effect only for time category axes.
    
    Returns:
    
    The scale value for major tick marks on the time category axis. The returned value is one of AxisTimeUnit constants.
  - setMajorUnitScale
```
public void setMajorUnitScale(int value)
```
    Sets the scale value for major tick marks on the time category axis. The property has effect only for time category axes.
    
    Parameters:
    
    value - The scale value for major tick marks on the time category axis. The value must be one of AxisTimeUnit constants.
  - getMinorUnit
```
public double getMinorUnit()
```
    Gets the distance between minor tick marks.
    Valid range of a value is greater than zero. The property has effect for time category and value axes.
    
    Setting this property sets the getMinorUnitIsAuto() / setMinorUnitIsAuto(boolean) property to false.
    
    Returns:
    
    The distance between minor tick marks.
  - setMinorUnit
```
public void setMinorUnit(double value)
```
    Sets the distance between minor tick marks.
    Valid range of a value is greater than zero. The property has effect for time category and value axes.
    
    Setting this property sets the getMinorUnitIsAuto() / setMinorUnitIsAuto(boolean) property to false.
    
    Parameters:
    
    value - The distance between minor tick marks.
  - getMinorUnitIsAuto
```
public boolean getMinorUnitIsAuto()
```
    Gets a flag indicating whether default distance between minor tick marks shall be used. The property has effect for time category and value axes.
    
    Returns:
    
    A flag indicating whether default distance between minor tick marks shall be used.
  - setMinorUnitIsAuto
```
public void setMinorUnitIsAuto(boolean value)
```
    Sets a flag indicating whether default distance between minor tick marks shall be used. The property has effect for time category and value axes.
    
    Parameters:
    
    value - A flag indicating whether default distance between minor tick marks shall be used.
  - getMinorUnitScale
```
public int getMinorUnitScale()
```
    Gets the scale value for minor tick marks on the time category axis. The property has effect only for time category axes.
    
    Returns:
    
    The scale value for minor tick marks on the time category axis. The returned value is one of AxisTimeUnit constants.
  - setMinorUnitScale
```
public void setMinorUnitScale(int value)
```
    Sets the scale value for minor tick marks on the time category axis. The property has effect only for time category axes.
    
    Parameters:
    
    value - The scale value for minor tick marks on the time category axis. The value must be one of AxisTimeUnit constants.
  - getBaseTimeUnit
```
public int getBaseTimeUnit()
```
    Gets the smallest time unit that is represented on the time category axis. The property has effect only for time category axes.
    
    Returns:
    
    The smallest time unit that is represented on the time category axis. The returned value is one of AxisTimeUnit constants.
  - setBaseTimeUnit
```
public void setBaseTimeUnit(int value)
```
    Sets the smallest time unit that is represented on the time category axis. The property has effect only for time category axes.
    
    Parameters:
    
    value - The smallest time unit that is represented on the time category axis. The value must be one of AxisTimeUnit constants.
  - getNumberFormat
```
public ChartNumberFormat getNumberFormat()
```
    Returns a ChartNumberFormat object that allows defining number formats for the axis.
    
    Returns:
    
    A ChartNumberFormat object that allows defining number formats for the axis.
  - getTickLabelOffset
```
public int getTickLabelOffset()
```
    Gets the distance of labels from the axis.
    The property represents a percentage of the default label offset.
    
    Valid range is from 0 to 1000 percent inclusive. Default value is 100%.
    
    The property has effect only for category axes. It is not supported by MS Office 2016 new charts.
    
    Returns:
    
    The distance of labels from the axis.
  - setTickLabelOffset
```
public void setTickLabelOffset(int value)
```
    Sets the distance of labels from the axis.
    The property represents a percentage of the default label offset.
    
    Valid range is from 0 to 1000 percent inclusive. Default value is 100%.
    
    The property has effect only for category axes. It is not supported by MS Office 2016 new charts.
    
    Parameters:
    
    value - The distance of labels from the axis.
  - getDisplayUnit
```
public AxisDisplayUnit getDisplayUnit()
```
    Specifies the scaling value of the display units for the value axis. The property has effect only for value axes.
    
    Returns:
    
    The corresponding AxisDisplayUnit value.
  - getAxisBetweenCategories
```
public boolean getAxisBetweenCategories()
```
    Gets a flag indicating whether the value axis crosses the category axis between categories. The property has effect only for value axes. It is not supported by MS Office 2016 new charts.
    
    Returns:
    
    A flag indicating whether the value axis crosses the category axis between categories.
  - setAxisBetweenCategories
```
public void setAxisBetweenCategories(boolean value)
```
    Sets a flag indicating whether the value axis crosses the category axis between categories. The property has effect only for value axes. It is not supported by MS Office 2016 new charts.
    
    Parameters:
    
    value - A flag indicating whether the value axis crosses the category axis between categories.
  - getScaling
```
public AxisScaling getScaling()
```
    Provides access to the scaling options of the axis.
    
    Returns:
    
    The corresponding AxisScaling value.
  - getTickLabelSpacing
```
public int getTickLabelSpacing()
```
    Gets the interval, at which tick labels are drawn.
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts. Valid range of a value is greater than or equal to 1.
    
    Setting this property sets the getTickLabelSpacingIsAuto() / setTickLabelSpacingIsAuto(boolean) property to false.
    
    Returns:
    
    The interval, at which tick labels are drawn.
  - setTickLabelSpacing
```
public void setTickLabelSpacing(int value)
```
    Sets the interval, at which tick labels are drawn.
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts. Valid range of a value is greater than or equal to 1.
    
    Setting this property sets the getTickLabelSpacingIsAuto() / setTickLabelSpacingIsAuto(boolean) property to false.
    
    Parameters:
    
    value - The interval, at which tick labels are drawn.
  - getTickLabelSpacingIsAuto
```
public boolean getTickLabelSpacingIsAuto()
```
    Gets a flag indicating whether automatic interval of drawing tick labels shall be used.
    Default value is true.
    
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.
    
    Returns:
    
    A flag indicating whether automatic interval of drawing tick labels shall be used.
  - setTickLabelSpacingIsAuto
```
public void setTickLabelSpacingIsAuto(boolean value)
```
    Sets a flag indicating whether automatic interval of drawing tick labels shall be used.
    Default value is true.
    
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.
    
    Parameters:
    
    value - A flag indicating whether automatic interval of drawing tick labels shall be used.
  - getTickLabelAlignment
```
public int getTickLabelAlignment()
```
    Gets text alignment of axis tick labels.
    This property has effect only for multi-line labels.
    
    Default value is ParagraphAlignment.CENTER.
    .
    
    Returns:
    
    Text alignment of axis tick labels. The returned value is one of ParagraphAlignment constants.
  - setTickLabelAlignment
```
public void setTickLabelAlignment(int value)
```
    Sets text alignment of axis tick labels.
    This property has effect only for multi-line labels.
    
    Default value is ParagraphAlignment.CENTER.
    .
    
    Parameters:
    
    value - Text alignment of axis tick labels. The value must be one of ParagraphAlignment constants.
  - getTickMarkSpacing
```
public int getTickMarkSpacing()
```
    Gets the interval, at which tick marks are drawn.
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.
    
    Valid range of a value is greater than or equal to 1.
    
    Returns:
    
    The interval, at which tick marks are drawn.
  - setTickMarkSpacing
```
public void setTickMarkSpacing(int value)
```
    Sets the interval, at which tick marks are drawn.
    The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.
    
    Valid range of a value is greater than or equal to 1.
    
    Parameters:
    
    value - The interval, at which tick marks are drawn.
  - getHidden
```
public boolean getHidden()
```
    Gets a flag indicating whether this axis is hidden or not. Default value is false.
    
    Returns:
    
    A flag indicating whether this axis is hidden or not.
  - setHidden
```
public void setHidden(boolean value)
```
    Sets a flag indicating whether this axis is hidden or not. Default value is false.
    
    Parameters:
    
    value - A flag indicating whether this axis is hidden or not.
  - getTitle
```
public ChartTitle getTitle()
```
  - setTitle
```
public void setTitle(ChartTitle value)
```
  - getTitlePosition
```
public int getTitlePosition()
```
  - getDocument
```
public DocumentBase getDocument()
```
    Returns the Document the title holder belongs.
    
    Returns:
    
    The Document the title holder belongs.
  - getTitleDeleted
```
public boolean getTitleDeleted()
```
  - setTitleDeleted
```
public void setTitleDeleted(boolean value)
```
  - isVisible
```
public boolean isVisible()
```
  - isInherited
```
public boolean isInherited()
```
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class ChartAxis

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getType

getCategoryType

setCategoryType

getCrosses

setCrosses

getCrossesAt

setCrossesAt

getReverseOrder

setReverseOrder

getMajorTickMark

setMajorTickMark

getMinorTickMark

setMinorTickMark

getTickLabelPosition

setTickLabelPosition

getMajorUnit

setMajorUnit

getMajorUnitIsAuto

setMajorUnitIsAuto

getMajorUnitScale

setMajorUnitScale

getMinorUnit

setMinorUnit

getMinorUnitIsAuto

setMinorUnitIsAuto

getMinorUnitScale

setMinorUnitScale

getBaseTimeUnit

setBaseTimeUnit

getNumberFormat

getTickLabelOffset

setTickLabelOffset

getDisplayUnit

getAxisBetweenCategories

setAxisBetweenCategories

getScaling

getTickLabelSpacing

setTickLabelSpacing

getTickLabelSpacingIsAuto

setTickLabelSpacingIsAuto

getTickLabelAlignment

setTickLabelAlignment

getTickMarkSpacing

setTickMarkSpacing

getHidden

setHidden

getTitle

setTitle

getTitlePosition

getDocument

getTitleDeleted

setTitleDeleted

isVisible

isInherited

memberwiseClone