com.aspose.words

Class AxisBuiltInUnit

java.lang.Object

com.aspose.words.AxisBuiltInUnit

public class AxisBuiltInUnit
extends java.lang.Object

Specifies the display units for an axis.

Examples:

Shows how to manipulate the tick marks and displayed values of a chart axis.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.SCATTER, 450.0, 250.0);
 Chart chart = shape.getChart();

 Assert.assertEquals(1, chart.getSeries().getCount());
 Assert.assertEquals("Y-Values", chart.getSeries().get(0).getName());

 // Set the minor tick marks of the Y-axis to point away from the plot area,
 // and the major tick marks to cross the axis.
 ChartAxis axis = chart.getAxisY();
 axis.setMajorTickMark(AxisTickMark.CROSS);
 axis.setMinorTickMark(AxisTickMark.OUTSIDE);

 // Set they Y-axis to show a major tick every 10 units, and a minor tick every 1 unit.
 axis.setMajorUnit(10.0);
 axis.setMinorUnit(1.0);

 // Set the Y-axis bounds to -10 and 20.
 // This Y-axis will now display 4 major tick marks and 27 minor tick marks.
 axis.getScaling().setMinimum(new AxisBound(-10));
 axis.getScaling().setMaximum(new AxisBound(20.0));

 // For the X-axis, set the major tick marks at every 10 units,
 // every minor tick mark at 2.5 units.
 axis = chart.getAxisX();
 axis.setMajorUnit(10.0);
 axis.setMinorUnit(2.5);

 // Configure both types of tick marks to appear inside the graph plot area.
 axis.setMajorTickMark(AxisTickMark.INSIDE);
 axis.setMinorTickMark(AxisTickMark.INSIDE);

 // Set the X-axis bounds so that the X-axis spans 5 major tick marks and 12 minor tick marks.
 axis.getScaling().setMinimum(new AxisBound(-10));
 axis.getScaling().setMaximum(new AxisBound(30.0));
 axis.getTickLabels().setAlignment(ParagraphAlignment.RIGHT);

 Assert.assertEquals(1, axis.getTickLabels().getSpacing());
 Assert.assertEquals(doc, axis.getDisplayUnit().getDocument());

 // Set the tick labels to display their value in millions.
 axis.getDisplayUnit().setUnit(AxisBuiltInUnit.MILLIONS);

 // We can set a more specific value by which tick labels will display their values.
 // This statement is equivalent to the one above.
 axis.getDisplayUnit().setCustomUnit(1000000.0);
 doc.save(getArtifactsDir() + "Charts.AxisDisplayUnit.docx");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	BILLIONS Specifies the values on the chart shall be divided by 1,000,000,000.
static int	CUSTOM Specifies the values on the chart shall be divided by a user-defined divisor.
static int	HUNDRED_MILLIONS Specifies the values on the chart shall be divided by 100,000,000.
static int	HUNDRED_THOUSANDS Specifies the values on the chart shall be divided by 100,000.
static int	HUNDREDS Specifies the values on the chart shall be divided by 100.
static int	length
static int	MILLIONS Specifies the values on the chart shall be divided by 1,000,000.
static int	NONE Specifies the values on the chart shall displayed as is.
static int	PERCENTAGE Specifies the values on the chart shall be divided by 0.01.
static int	TEN_MILLIONS Specifies the values on the chart shall be divided by 10,000,000.
static int	TEN_THOUSANDS Specifies the values on the chart shall be divided by 10,000.
static int	THOUSANDS Specifies the values on the chart shall be divided by 1,000.
static int	TRILLIONS Specifies the values on the chart shall be divided by 1,000,000,000,0000.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String axisBuiltInUnitName)
static java.lang.String	getName(int axisBuiltInUnit)
static int[]	getValues()
static java.lang.String	toString(int axisBuiltInUnit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static int NONE

Specifies the values on the chart shall displayed as is.

CUSTOM

public static int CUSTOM

Specifies the values on the chart shall be divided by a user-defined divisor. This value is not supported by the new chart types of MS Office 2016.

BILLIONS

public static int BILLIONS

Specifies the values on the chart shall be divided by 1,000,000,000.

HUNDRED_MILLIONS

public static int HUNDRED_MILLIONS

Specifies the values on the chart shall be divided by 100,000,000.

HUNDREDS

public static int HUNDREDS

Specifies the values on the chart shall be divided by 100.

HUNDRED_THOUSANDS

public static int HUNDRED_THOUSANDS

Specifies the values on the chart shall be divided by 100,000.

MILLIONS

public static int MILLIONS

Specifies the values on the chart shall be divided by 1,000,000.

TEN_MILLIONS

public static int TEN_MILLIONS

Specifies the values on the chart shall be divided by 10,000,000.

TEN_THOUSANDS

public static int TEN_THOUSANDS

Specifies the values on the chart shall be divided by 10,000.

THOUSANDS

public static int THOUSANDS

Specifies the values on the chart shall be divided by 1,000.

TRILLIONS

public static int TRILLIONS

Specifies the values on the chart shall be divided by 1,000,000,000,0000.

PERCENTAGE

public static int PERCENTAGE

Specifies the values on the chart shall be divided by 0.01. This value is supported only by the new chart types of MS Office 2016.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int axisBuiltInUnit)

toString

public static java.lang.String toString(int axisBuiltInUnit)

fromName

public static int fromName(java.lang.String axisBuiltInUnitName)

getValues

public static int[] getValues()