Package io.keikai.axyra.sheets

Enum Class PivotDateGroupBy

java.lang.Object

java.lang.Enum<PivotDateGroupBy>

io.keikai.axyra.sheets.PivotDateGroupBy

All Implemented Interfaces:

Serializable, Comparable<PivotDateGroupBy>, Constable

public enum PivotDateGroupBy
extends Enum<PivotDateGroupBy>

Date component a pivot row/column field is grouped by (ECMA-376 Part 1 §18.10.1.81 rangePr@groupBy). Pass it to PivotTableView.groupFieldByDate(java.lang.String, io.keikai.axyra.sheets.PivotDateGroupBy). Items sort in calendar order; a source value that is not a date serial keeps its own label after the buckets.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAYS	Day of the month: items read "01" to "31".
HOURS	Hour of the day: items read "00" to "23".
MINUTES	Minute of the hour: items read "00" to "59".
MONTHS	Month: items read "Jan" to "Dec".
QUARTERS	Calendar quarter: items read "Qtr1" to "Qtr4".
SECONDS	Second of the minute: items read "00" to "59".
YEARS	Calendar year: items read "2024", "2025", and so on.

Method Summary

Modifier and Type	Method	Description
static PivotDateGroupBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PivotDateGroupBy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()	The OOXML groupBy token, also used across the FFI.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YEARS

public static final PivotDateGroupBy YEARS

Calendar year: items read "2024", "2025", and so on.

QUARTERS

public static final PivotDateGroupBy QUARTERS

Calendar quarter: items read "Qtr1" to "Qtr4".

MONTHS

public static final PivotDateGroupBy MONTHS

Month: items read "Jan" to "Dec".

DAYS

public static final PivotDateGroupBy DAYS

Day of the month: items read "01" to "31". Group with MONTHS as well to tell days of different months apart.

HOURS

public static final PivotDateGroupBy HOURS

Hour of the day: items read "00" to "23".

MINUTES

public static final PivotDateGroupBy MINUTES

Minute of the hour: items read "00" to "59".

SECONDS

public static final PivotDateGroupBy SECONDS

Second of the minute: items read "00" to "59".

Method Details

values

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

wire

public String wire()

The OOXML groupBy token, also used across the FFI.