ChartAxis

Overview

ChartAxis is a class in Aspose.Words FOSS for Java. Inherits from: IDmlChartTitleHolder, IDmlExtensionListSource, INumberFormatProvider, and 2 more.

Represents the axis options of the chart.

Edition status of its 66 listed members (a property and its accessor methods are listed separately, overloads once): 66 not yet exercised by a verified example.

This class declares 44 methods for ChartAxis objects in Java programs. Available methods include: getAxisBetweenCategories, getBaseTimeUnit, getCategoryType, getCrosses, getCrossesAt, getDisplayUnit, getDocument, getFormat, getHidden, getMajorTickMark, getMajorUnit, getMajorUnitIsAuto, and 30 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: axisBetweenCategories, baseTimeUnit, categoryType, crosses, crossesAt, displayUnit, and 18 more.

Properties

NameTypeAccessDescription
typeintReadReturns type of the axis.
categoryTypeintRead/WriteGets or sets type of the category axis.
crossesintRead/WriteSpecifies how this axis crosses the perpendicular axis.
crossesAtdoubleRead/WriteSpecifies where on the perpendicular axis the axis crosses.
reverseOrderbooleanRead/WriteReturns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min.
majorTickMarkintRead/WriteReturns or sets the major tick marks.
minorTickMarkintRead/WriteReturns or sets the minor tick marks for the axis.
majorUnitdoubleRead/WriteReturns or sets the distance between major tick marks.
majorUnitIsAutobooleanRead/WriteGets or sets a flag indicating whether default distance between major tick marks shall be used.
majorUnitScaleintRead/WriteReturns or sets the scale value for major tick marks on the time category axis.
minorUnitdoubleRead/WriteReturns or sets the distance between minor tick marks.
minorUnitIsAutobooleanRead/WriteGets or sets a flag indicating whether default distance between minor tick marks shall be used.
minorUnitScaleintRead/WriteReturns or sets the scale value for minor tick marks on the time category axis.
baseTimeUnitintRead/WriteReturns or sets the smallest time unit that is represented on the time category axis.
numberFormatChartNumberFormatReadReturns a ChartNumberFormat object that allows defining number formats for the axis.
displayUnitAxisDisplayUnitReadSpecifies the scaling value of the display units for the value axis.
axisBetweenCategoriesbooleanRead/WriteGets or sets a flag indicating whether the value axis crosses the category axis between categories.
scalingAxisScalingReadProvides access to the scaling options of the axis.
tickMarkSpacingintRead/WriteGets or sets the interval, at which tick marks are drawn.
hiddenbooleanRead/WriteGets or sets a flag indicating whether this axis is hidden or not.
titleChartAxisTitleReadProvides access to the axis title properties.
tickLabelsAxisTickLabelsReadProvides access to the properties of the axis tick mark labels.
formatChartFormatReadProvides access to line formatting of the axis and fill of the tick labels.
documentDocumentBaseReadReturns the document containing the parent chart.

Methods

SignatureDescription
getType() → intReturns type of the axis.
getCategoryType() → intGets or sets type of the category axis.
setCategoryType(value: int)Sets the category type value.
getCrosses() → intSpecifies how this axis crosses the perpendicular axis.
setCrosses(value: int)Sets the crosses value.
getCrossesAt() → doubleSpecifies where on the perpendicular axis the axis crosses.
setCrossesAt(value: double)Sets the crosses at value.
getReverseOrder() → booleanReturns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min.
setReverseOrder(value: boolean)Sets the reverse order value.
getMajorTickMark() → intReturns or sets the major tick marks.
setMajorTickMark(value: int)Sets the major tick mark value.
getMinorTickMark() → intReturns or sets the minor tick marks for the axis.
setMinorTickMark(value: int)Sets the minor tick mark value.
getMajorUnit() → doubleReturns or sets the distance between major tick marks.
setMajorUnit(value: double)Sets the major unit value.
getMajorUnitIsAuto() → booleanGets or sets a flag indicating whether default distance between major tick marks shall be used.
setMajorUnitIsAuto(value: boolean)Sets the major unit is auto value.
getMajorUnitScale() → intReturns or sets the scale value for major tick marks on the time category axis.
setMajorUnitScale(value: int)Sets the major unit scale value.
getMinorUnit() → doubleReturns or sets the distance between minor tick marks.
setMinorUnit(value: double)Sets the minor unit value.
getMinorUnitIsAuto() → booleanGets or sets a flag indicating whether default distance between minor tick marks shall be used.
setMinorUnitIsAuto(value: boolean)Sets the minor unit is auto value.
getMinorUnitScale() → intReturns or sets the scale value for minor tick marks on the time category axis.
setMinorUnitScale(value: int)Sets the minor unit scale value.
getBaseTimeUnit() → intReturns or sets the smallest time unit that is represented on the time category axis.
setBaseTimeUnit(value: int)Sets the base time unit value.
getNumberFormat() → ChartNumberFormatReturns a ChartNumberFormat object that allows defining number formats for the axis.
getDisplayUnit() → AxisDisplayUnitSpecifies the scaling value of the display units for the value axis.
getAxisBetweenCategories() → booleanGets or sets a flag indicating whether the value axis crosses the category axis between categories.
setAxisBetweenCategories(value: boolean)Sets the axis between categories value.
getScaling() → AxisScalingProvides access to the scaling options of the axis.
getTickMarkSpacing() → intGets or sets the interval, at which tick marks are drawn.
setTickMarkSpacing(value: int)Sets the tick mark spacing value.
getHidden() → booleanGets or sets a flag indicating whether this axis is hidden or not.
setHidden(value: boolean)Sets the hidden value.
hasMajorGridlines() → booleanGets or sets a flag indicating whether the axis has major gridlines.
hasMajorGridlines(value: boolean)Calls hasMajorGridlines(value) on this ChartAxis instance.
hasMinorGridlines() → booleanGets or sets a flag indicating whether the axis has minor gridlines.
hasMinorGridlines(value: boolean)Calls hasMinorGridlines(value) on this ChartAxis instance.
getTitle() → ChartAxisTitleProvides access to the axis title properties.
getTickLabels() → AxisTickLabelsProvides access to the properties of the axis tick mark labels.
getFormat() → ChartFormatProvides access to line formatting of the axis and fill of the tick labels.
getDocument() → DocumentBaseReturns the document containing the parent chart.

See Also