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

TimeUnit

Enum Class TimeUnit

java.lang.Object
java.lang.Enum<TimeUnit>
com.grapecity.documents.excel.drawing.TimeUnit
All Implemented Interfaces:
Serializable, Comparable<TimeUnit>, Constable
public enum TimeUnit extends Enum<TimeUnit>
Specifies the unit of time for a chart axis or data series.

Use this enum with date-based category axis settings such as IAxis.setBaseUnit(TimeUnit), IAxis.setMajorUnitScale(TimeUnit), and IAxis.setMinorUnitScale(TimeUnit) to control whether the axis is measured in days, months, or years.


 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Date", "Sales"},
     {new GregorianCalendar(2024, 0, 1).getTime(), 100},
     {new GregorianCalendar(2024, 1, 1).getTime(), 120},
     {new GregorianCalendar(2024, 2, 1).getTime(), 140}
 });
 IShape shape = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200);
 shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, true);
 IAxis axis = shape.getChart().getAxes().item(AxisType.Category);
 axis.setCategoryType(CategoryType.TimeScale);
 axis.setBaseUnit(TimeUnit.Months);

  • Enum Constant Details

    • Days

      public static final TimeUnit Days
      Specifies days.

    • Months

      public static final TimeUnit Months
      Specifies months.

    • Years

      public static final TimeUnit Years
      Specifies years.

  • Method Details

    • values

      public static TimeUnit[] 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 TimeUnit 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