Package io.keikai.axyra.sheets

Enum Class DynamicFilterType

java.lang.Object
java.lang.Enum<DynamicFilterType>
io.keikai.axyra.sheets.DynamicFilterType
All Implemented Interfaces:
Serializable, Comparable<DynamicFilterType>, Constable
public enum DynamicFilterType extends Enum<DynamicFilterType>
Dynamic auto-filter kind (ECMA-376 §18.18.26 ST_DynamicFilterType).

The date kinds resolve their range at Sheet.applyAutoFilter() time relative to the current date (weeks start on Sunday, Excel's en-US default); ABOVE_AVERAGE / BELOW_AVERAGE compute the column average over the data rows. "Today" is the current date in the host's local time zone, read when the filter is applied.

  • Enum Constant Details

    • TODAY

      public static final DynamicFilterType TODAY
      Dates equal to today.

    • YESTERDAY

      public static final DynamicFilterType YESTERDAY
      Dates equal to yesterday.

    • TOMORROW

      public static final DynamicFilterType TOMORROW
      Dates equal to tomorrow.

    • THIS_WEEK

      public static final DynamicFilterType THIS_WEEK
      Dates in the current Sunday-to-Saturday week.

    • LAST_WEEK

      public static final DynamicFilterType LAST_WEEK
      Dates in the previous Sunday-to-Saturday week.

    • NEXT_WEEK

      public static final DynamicFilterType NEXT_WEEK
      Dates in the next Sunday-to-Saturday week.

    • THIS_MONTH

      public static final DynamicFilterType THIS_MONTH
      Dates in the current calendar month.

    • LAST_MONTH

      public static final DynamicFilterType LAST_MONTH
      Dates in the previous calendar month.

    • NEXT_MONTH

      public static final DynamicFilterType NEXT_MONTH
      Dates in the next calendar month.

    • THIS_QUARTER

      public static final DynamicFilterType THIS_QUARTER
      Dates in the current calendar quarter.

    • LAST_QUARTER

      public static final DynamicFilterType LAST_QUARTER
      Dates in the previous calendar quarter.

    • NEXT_QUARTER

      public static final DynamicFilterType NEXT_QUARTER
      Dates in the next calendar quarter.

    • THIS_YEAR

      public static final DynamicFilterType THIS_YEAR
      Dates in the current calendar year.

    • LAST_YEAR

      public static final DynamicFilterType LAST_YEAR
      Dates in the previous calendar year.

    • NEXT_YEAR

      public static final DynamicFilterType NEXT_YEAR
      Dates in the next calendar year.

    • YEAR_TO_DATE

      public static final DynamicFilterType YEAR_TO_DATE
      Dates from January 1 of this year up to and including today.

    • ABOVE_AVERAGE

      public static final DynamicFilterType ABOVE_AVERAGE
      Numbers above the average of the column's data rows.

    • BELOW_AVERAGE

      public static final DynamicFilterType BELOW_AVERAGE
      Numbers below the average of the column's data rows.

  • Method Details

    • values

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

    • code

      public String code()
      Returns the ECMA-376 token for this kind, e.g. "thisWeek".