[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

DisplayUnit

Enum Class DisplayUnit

java.lang.Object
java.lang.Enum<DisplayUnit>
com.grapecity.documents.excel.drawing.DisplayUnit
All Implemented Interfaces:
Serializable, Comparable<DisplayUnit>, Constable
public enum DisplayUnit extends Enum<DisplayUnit>
Specifies the display unit for a value axis.

Use this enum with IAxis.setDisplayUnit(DisplayUnit) to scale the values shown on a chart axis and its display unit label. Use Custom together with the custom display unit settings on the axis when you need a unit value that is not represented by the built-in options.


 worksheet.getRange("A1:B3").setValue(new Object[][] {
     {"Month", "Sales"},
     {"Jan", 1200},
     {"Feb", 1800}
 });
 IShape shape = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 220);
 shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:B3"), RowCol.Columns, true, true);
 IAxis valueAxis = shape.getChart().getAxes().item(AxisType.Value);
 valueAxis.setDisplayUnit(DisplayUnit.Hundreds);

  • Enum Constant Details

    • None

      public static final DisplayUnit None
      Specifies no units.

    • Custom

      public static final DisplayUnit Custom
      Specifies a custom unit.

    • MillionMillions

      public static final DisplayUnit MillionMillions
      Specifies millions of millions.

    • ThousandMillions

      public static final DisplayUnit ThousandMillions
      Specifies thousands of millions.

    • HundredMillions

      public static final DisplayUnit HundredMillions
      Specifies hundreds of millions.

    • TenMillions

      public static final DisplayUnit TenMillions
      Specifies tens of millions.

    • Millions

      public static final DisplayUnit Millions
      Specifies millions.

    • HundredThousands

      public static final DisplayUnit HundredThousands
      Specifies hundreds of thousands.

    • TenThousands

      public static final DisplayUnit TenThousands
      Specifies tens of thousands.

    • Thousands

      public static final DisplayUnit Thousands
      Specifies thousands.

    • Hundreds

      public static final DisplayUnit Hundreds
      Specifies hundreds.

  • Method Details

    • values

      public static DisplayUnit[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DisplayUnit valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null