com.aspose.words

Class ChartAxis

  • java.lang.Object
    • com.aspose.words.ChartAxis
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ChartAxis 
    extends java.lang.Object

Represents the axis options of the chart.

Property Getters/Setters Summary
booleangetAxisBetweenCategories()
void
           Gets or sets a flag indicating whether the value axis crosses the category axis between categories.
intgetBaseTimeUnit()
void
setBaseTimeUnit(intvalue)
           Returns or sets the smallest time unit that is represented on the time category axis. The value of the property is AxisTimeUnit integer constant.
intgetCategoryType()
void
setCategoryType(intvalue)
           Gets or sets type of the category axis. The value of the property is AxisCategoryType integer constant.
intgetCrosses()
void
setCrosses(intvalue)
           Specifies how this axis crosses the perpendicular axis. The value of the property is AxisCrosses integer constant.
doublegetCrossesAt()
void
setCrossesAt(doublevalue)
           Specifies where on the perpendicular axis the axis crosses.
AxisDisplayUnitgetDisplayUnit()
Specifies the scaling value of the display units for the value axis.
booleangetHidden()
void
setHidden(booleanvalue)
           Gets or sets a flag indicating whether this axis is hidden or not.
intgetMajorTickMark()
void
           Returns or sets the major tick marks. The value of the property is AxisTickMark integer constant.
doublegetMajorUnit()
void
setMajorUnit(doublevalue)
           Returns or sets the distance between major tick marks.
booleangetMajorUnitIsAuto()
void
setMajorUnitIsAuto(booleanvalue)
           Gets or sets a flag indicating whether default distance between major tick marks shall be used.
intgetMajorUnitScale()
void
           Returns or sets the scale value for major tick marks on the time category axis. The value of the property is AxisTimeUnit integer constant.
intgetMinorTickMark()
void
           Returns or sets the minor tick marks for the axis. The value of the property is AxisTickMark integer constant.
doublegetMinorUnit()
void
setMinorUnit(doublevalue)
           Returns or sets the distance between minor tick marks.
booleangetMinorUnitIsAuto()
void
setMinorUnitIsAuto(booleanvalue)
           Gets or sets a flag indicating whether default distance between minor tick marks shall be used.
intgetMinorUnitScale()
void
           Returns or sets the scale value for minor tick marks on the time category axis. The value of the property is AxisTimeUnit integer constant.
ChartNumberFormatgetNumberFormat()
Returns a ChartNumberFormat object that allows defining number formats for the axis.
booleangetReverseOrder()
void
setReverseOrder(booleanvalue)
           Returns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min.
AxisScalinggetScaling()
Provides access to the scaling options of the axis.
intgetTickLabelOffset()
void
           Gets or sets the distance of labels from the axis.
intgetTickLabelPosition()
void
           Returns or sets the position of the tick labels on the axis. The value of the property is AxisTickLabelPosition integer constant.
intgetTickLabelSpacing()
void
           Gets or sets the interval, at which tick labels are drawn.
booleangetTickLabelSpacingIsAuto()
void
           Gets or sets a flag indicating whether automatic interval of drawing tick labels shall be used.
intgetTickMarkSpacing()
void
           Gets or sets the interval, at which tick marks are drawn.
intgetType()
Returns type of the axis. The value of the property is ChartAxisType integer constant.
 

    • Property Getters/Setters Detail

      • getAxisBetweenCategories/setAxisBetweenCategories

        public boolean getAxisBetweenCategories() / public void setAxisBetweenCategories(boolean value)
        
        Gets or 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.
      • getBaseTimeUnit/setBaseTimeUnit

        public int getBaseTimeUnit() / public void setBaseTimeUnit(int value)
        
        Returns or sets the smallest time unit that is represented on the time category axis. The value of the property is AxisTimeUnit integer constant. The property has effect only for time category axes.
      • getCategoryType/setCategoryType

        public int getCategoryType() / public void setCategoryType(int value)
        
        Gets or sets type of the category axis. The value of the property is AxisCategoryType integer constant. Only text categories (AxisCategoryType.CATEGORY) are allowed in MS Office 2016 new charts.
      • getCrosses/setCrosses

        public int getCrosses() / public void setCrosses(int value)
        
        Specifies how this axis crosses the perpendicular axis. The value of the property is AxisCrosses integer constant.

        Default value is AxisCrosses.AUTOMATIC.

        The property is not supported by MS Office 2016 new charts.

      • getCrossesAt/setCrossesAt

        public double getCrossesAt() / public void setCrossesAt(double value)
        
        Specifies where on the perpendicular axis the axis crosses.

        The property has effect only if Crosses 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.

      • getDisplayUnit

        public AxisDisplayUnit getDisplayUnit()
        
        Specifies the scaling value of the display units for the value axis. The property has effect only for value axes.
      • getHidden/setHidden

        public boolean getHidden() / public void setHidden(boolean value)
        
        Gets or sets a flag indicating whether this axis is hidden or not. Default value is false.
      • getMajorTickMark/setMajorTickMark

        public int getMajorTickMark() / public void setMajorTickMark(int value)
        
        Returns or sets the major tick marks. The value of the property is AxisTickMark integer constant.
      • getMajorUnit/setMajorUnit

        public double getMajorUnit() / public void setMajorUnit(double value)
        
        Returns or 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 MajorUnitIsAuto property to false.

      • getMajorUnitIsAuto/setMajorUnitIsAuto

        public boolean getMajorUnitIsAuto() / public void setMajorUnitIsAuto(boolean value)
        
        Gets or sets a flag indicating whether default distance between major tick marks shall be used. The property has effect for time category and value axes.
      • getMajorUnitScale/setMajorUnitScale

        public int getMajorUnitScale() / public void setMajorUnitScale(int value)
        
        Returns or sets the scale value for major tick marks on the time category axis. The value of the property is AxisTimeUnit integer constant. The property has effect only for time category axes.
      • getMinorTickMark/setMinorTickMark

        public int getMinorTickMark() / public void setMinorTickMark(int value)
        
        Returns or sets the minor tick marks for the axis. The value of the property is AxisTickMark integer constant.
      • getMinorUnit/setMinorUnit

        public double getMinorUnit() / public void setMinorUnit(double value)
        
        Returns or 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 MinorUnitIsAuto property to false.

      • getMinorUnitIsAuto/setMinorUnitIsAuto

        public boolean getMinorUnitIsAuto() / public void setMinorUnitIsAuto(boolean value)
        
        Gets or sets a flag indicating whether default distance between minor tick marks shall be used. The property has effect for time category and value axes.
      • getMinorUnitScale/setMinorUnitScale

        public int getMinorUnitScale() / public void setMinorUnitScale(int value)
        
        Returns or sets the scale value for minor tick marks on the time category axis. The value of the property is AxisTimeUnit integer constant. The property has effect only for time category axes.
      • getReverseOrder/setReverseOrder

        public boolean getReverseOrder() / public void setReverseOrder(boolean value)
        
        Returns or 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.
      • getScaling

        public AxisScaling getScaling()
        
        Provides access to the scaling options of the axis.
      • getTickLabelOffset/setTickLabelOffset

        public int getTickLabelOffset() / public void setTickLabelOffset(int value)
        
        Gets or 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.

      • getTickLabelPosition/setTickLabelPosition

        public int getTickLabelPosition() / public void setTickLabelPosition(int value)
        
        Returns or sets the position of the tick labels on the axis. The value of the property is AxisTickLabelPosition integer constant. The property is not supported by MS Office 2016 new charts.
      • getTickLabelSpacing/setTickLabelSpacing

        public int getTickLabelSpacing() / public void setTickLabelSpacing(int value)
        
        Gets or 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 TickLabelSpacingIsAuto property to false.

      • getTickLabelSpacingIsAuto/setTickLabelSpacingIsAuto

        public boolean getTickLabelSpacingIsAuto() / public void setTickLabelSpacingIsAuto(boolean value)
        
        Gets or 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.

      • getTickMarkSpacing/setTickMarkSpacing

        public int getTickMarkSpacing() / public void setTickMarkSpacing(int value)
        
        Gets or 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.

      • getType

        public int getType()
        
        Returns type of the axis. The value of the property is ChartAxisType integer constant.