ChartAxis class

ChartAxis class

Represents the axis options of the chart. To learn more, visit the Working with Charts documentation article.

Properties

NameDescription
axis_between_categoriesGets or sets a flag indicating whether the value axis crosses the category axis between categories.
base_time_unitReturns or sets the smallest time unit that is represented on the time category axis.
category_typeGets or sets type of the category axis.
crossesSpecifies how this axis crosses the perpendicular axis.
crosses_atSpecifies where on the perpendicular axis the axis crosses.
display_unitSpecifies the scaling value of the display units for the value axis.
documentReturns the document containing the parent chart.
formatProvides access to line formatting of the axis and fill of the tick labels.
has_major_gridlinesGets or sets a flag indicating whether the axis has major gridlines.
has_minor_gridlinesGets or sets a flag indicating whether the axis has minor gridlines.
hiddenGets or sets a flag indicating whether this axis is hidden or not.
major_tick_markReturns or sets the major tick marks.
major_unitReturns or sets the distance between major tick marks.
major_unit_is_autoGets or sets a flag indicating whether default distance between major tick marks shall be used.
major_unit_scaleReturns or sets the scale value for major tick marks on the time category axis.
minor_tick_markReturns or sets the minor tick marks for the axis.
minor_unitReturns or sets the distance between minor tick marks.
minor_unit_is_autoGets or sets a flag indicating whether default distance between minor tick marks shall be used.
minor_unit_scaleReturns or sets the scale value for minor tick marks on the time category axis.
number_formatReturns a ChartNumberFormat object that allows defining number formats for the axis.
reverse_orderReturns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min.
scalingProvides access to the scaling options of the axis.
tick_label_alignmentGets or sets text alignment of axis tick labels.
tick_label_offsetGets or sets the distance of labels from the axis.
tick_label_positionReturns or sets the position of the tick labels on the axis.
tick_label_spacingGets or sets the interval, at which tick labels are drawn.
tick_label_spacing_is_autoGets or sets a flag indicating whether automatic interval of drawing tick labels shall be used.
tick_labelsProvides access to the properties of the axis tick mark labels.
tick_mark_spacingGets or sets the interval, at which tick marks are drawn.
titleProvides access to the axis title properties.
typeReturns type of the axis.

Examples

Shows how to insert a chart and modify the appearance of its axes.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

shape = builder.insert_chart(aw.drawing.charts.ChartType.COLUMN, 500, 300)
chart = shape.chart

# Clear the chart's demo data series to start with a clean chart.
chart.series.clear()

# Insert a chart series with categories for the X-axis and respective numeric values for the Y-axis.
chart.series.add("Aspose Test Series",
    ["Word", "PDF", "Excel", "GoogleDocs", "Note"],
    [640, 320, 280, 120, 150])

# Chart axes have various options that can change their appearance,
# such as their direction, major/minor unit ticks, and tick marks.
x_axis = chart.axis_x
x_axis.category_type = aw.drawing.charts.AxisCategoryType.CATEGORY
x_axis.crosses = aw.drawing.charts.AxisCrosses.MINIMUM
x_axis.reverse_order = False
x_axis.major_tick_mark = aw.drawing.charts.AxisTickMark.INSIDE
x_axis.minor_tick_mark = aw.drawing.charts.AxisTickMark.CROSS
x_axis.major_unit = 10.0
x_axis.minor_unit = 15.0
x_axis.tick_labels.offset = 50
x_axis.tick_labels.position = aw.drawing.charts.AxisTickLabelPosition.LOW
x_axis.tick_labels.is_auto_spacing = False
x_axis.tick_mark_spacing = 1

y_axis = chart.axis_y
y_axis.category_type = aw.drawing.charts.AxisCategoryType.AUTOMATIC
y_axis.crosses = aw.drawing.charts.AxisCrosses.MAXIMUM
y_axis.reverse_order = True
y_axis.major_tick_mark = aw.drawing.charts.AxisTickMark.INSIDE
y_axis.minor_tick_mark = aw.drawing.charts.AxisTickMark.CROSS
y_axis.major_unit = 100.0
y_axis.minor_unit = 20.0
y_axis.tick_labels.position = aw.drawing.charts.AxisTickLabelPosition.NEXT_TO_AXIS

# Column charts do not have a Z-axis.
self.assertIsNone(chart.axis_z)

doc.save(ARTIFACTS_DIR + "Charts.axis_properties.docx")

See Also