ChartAxis class

ChartAxis class

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

Properties

NameDescription
axisBetweenCategoriesGets or sets a flag indicating whether the value axis crosses the category axis between categories.
baseTimeUnitReturns or sets the smallest time unit that is represented on the time category axis.
categoryTypeGets or sets type of the category axis.
crossesSpecifies how this axis crosses the perpendicular axis.
crossesAtSpecifies where on the perpendicular axis the axis crosses.
displayUnitSpecifies 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.
hasMajorGridlinesGets or sets a flag indicating whether the axis has major gridlines.
hasMinorGridlinesGets or sets a flag indicating whether the axis has minor gridlines.
hiddenGets or sets a flag indicating whether this axis is hidden or not.
majorTickMarkReturns or sets the major tick marks.
majorUnitReturns or sets the distance between major tick marks.
majorUnitIsAutoGets or sets a flag indicating whether default distance between major tick marks shall be used.
majorUnitScaleReturns or sets the scale value for major tick marks on the time category axis.
minorTickMarkReturns or sets the minor tick marks for the axis.
minorUnitReturns or sets the distance between minor tick marks.
minorUnitIsAutoGets or sets a flag indicating whether default distance between minor tick marks shall be used.
minorUnitScaleReturns or sets the scale value for minor tick marks on the time category axis.
numberFormatReturns a ChartNumberFormat object that allows defining number formats for the axis.
reverseOrderReturns 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.
tickLabelsProvides access to the properties of the axis tick mark labels.
tickMarkSpacingGets 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.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

let shape = builder.insertChart(aw.Drawing.Charts.ChartType.Column, 500, 300);
let 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.
let xAxis = chart.axisX;
xAxis.categoryType = aw.Drawing.Charts.AxisCategoryType.Category;
xAxis.crosses = aw.Drawing.Charts.AxisCrosses.Minimum;
xAxis.reverseOrder = false;
xAxis.majorTickMark = aw.Drawing.Charts.AxisTickMark.Inside;
xAxis.minorTickMark = aw.Drawing.Charts.AxisTickMark.Cross;
xAxis.majorUnit = 10.0;
xAxis.minorUnit = 15.0;
xAxis.tickLabels.offset = 50;
xAxis.tickLabels.position = aw.Drawing.Charts.AxisTickLabelPosition.Low;
xAxis.tickLabels.isAutoSpacing = false;
xAxis.tickMarkSpacing = 1;

expect(xAxis.document.referenceEquals(doc)).toEqual(true);

let yAxis = chart.axisY;
yAxis.categoryType = aw.Drawing.Charts.AxisCategoryType.Automatic;
yAxis.crosses = aw.Drawing.Charts.AxisCrosses.Maximum;
yAxis.reverseOrder = true;
yAxis.majorTickMark = aw.Drawing.Charts.AxisTickMark.Inside;
yAxis.minorTickMark = aw.Drawing.Charts.AxisTickMark.Cross;
yAxis.majorUnit = 100.0;
yAxis.minorUnit = 20.0;
yAxis.tickLabels.position = aw.Drawing.Charts.AxisTickLabelPosition.NextToAxis;
yAxis.tickLabels.alignment = aw.ParagraphAlignment.Center;
yAxis.tickLabels.font.color = "#FF0000";
yAxis.tickLabels.spacing = 1;

// Column charts do not have a Z-axis.
expect(chart.axisZ).toBe(null);

doc.save(base.artifactsDir + "Charts.AxisProperties.docx");

See Also