Package com.grapecity.documents.excel

Enum Class PivotFilterType

java.lang.Object
java.lang.Enum<PivotFilterType>
com.grapecity.documents.excel.PivotFilterType
All Implemented Interfaces:
Serializable, Comparable<PivotFilterType>, Constable
public enum PivotFilterType extends Enum<PivotFilterType>
The type of pivot filter

  • 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
    CaptionBeginsWith
    Filters the data where the caption starts with the specified value.
    CaptionBetween
    Filters the data where the caption is between the specified values.
    CaptionContains
    Filters the data where the caption contains the specified value.
    CaptionEndsWith
    Filters the data where the caption ends with the specified value.
    CaptionEqual
    Filters the data where the caption is equal to the specified value.
    CaptionGreaterThan
    Filters the data where the caption is greater than the specified value.
    CaptionGreaterThanOrEqual
    Filters the data where the caption is greater than or equal to the specified value.
    CaptionLessThan
    Filters the data where the caption is less than the specified value.
    CaptionLessThanOrEqual
    Filters the data where the caption is less than or equal to the specified value.
    CaptionNotBeginsWith
    Filters the data where the caption does not start with the specified value.
    CaptionNotBetween
    Filters the data where the caption is not between the specified values.
    CaptionNotContains
    Filters the data where the caption does not contain the specified value.
    CaptionNotEndsWith
    Filters the data where the caption does not end with the specified value.
    CaptionNotEqual
    Filters the data where the caption is not equal to the specified value.
    Count
    Filters the specified number of items containing top/bottom values.
    DateBetween
    Filters the data where the date is between the specified values.
    DateEqual
    Filters the data where the date is equal to the specified value.
    DateNewerThan
    Filters the data where the date is newer than the specified value.
    DateNewerThanOrEqual
    Filters the data where the date is newer than or equal to the specified value.
    DateNotBetween
    Filters the data where the date is not between the specified values.
    DateNotEqual
    Filters the data where the date is not equal to the specified value.
    DateOlderThan
    Filters the data where the date is older than the specified value.
    DateOlderThanOrEqual
    Filters the data where the date is older than or equal to the specified value.
    LastMonth
    Filters the data for the last month.
    LastQuarter
    Filters the data for the last quarter.
    LastWeek
    Filters the data for the last week.
    LastYear
    Filters the data for the last year.
    M1
    Filters the data for January.
    M10
    Filters the data for October.
    M11
    Filters the data for November.
    M12
    Filters the data for December.
    M2
    Filters the data for February.
    M3
    Filters the data for March.
    M4
    Filters the data for April.
    M5
    Filters the data for May.
    M6
    Filters the data for June.
    M7
    Filters the data for July.
    M8
    Filters the data for August.
    M9
    Filters the data for September.
    NextMonth
    Filters the data for the next month.
    NextQuarter
    Filters the data for the next quarter.
    NextWeek
    Filters the data for the next week.
    NextYear
    Filters the data for the next year.
    Percent
    Filters top/bottom items that comprise not less than the specified percent of the total of the field values.
    Q1
    Filters the data for the first quarter.
    Q2
    Filters the data for the second quarter.
    Q3
    Filters the data for the third quarter.
    Q4
    Filters the data for the fourth quarter.
    Sum
    Filters top/bottom items that comprise not less than the specified sum of the values.
    ThisMonth
    Filters the data for the current month.
    ThisQuarter
    Filters the data for the current quarter.
    ThisWeek
    Filters the data for the current week.
    ThisYear
    Filters the data for the current year.
    Today
    Filters the data for today.
    Tomorrow
    Filters the data for tomorrow.
    ValueBetween
    Filters the data where the value is between the specified values.
    ValueEqual
    Filters the data where the value is equal to the specified value.
    ValueGreaterThan
    Filters the data where the value is greater than the specified value.
    ValueGreaterThanOrEqual
    Filters the data where the value is greater than or equal to the specified value.
    ValueLessThan
    Filters the data where the value is less than the specified value.
    ValueLessThanOrEqual
    Filters content where the value is less than or equal to the specified value.
    ValueNotBetween
    Filters content where the value is not between the specified values (inclusive).
    ValueNotEqual
    Filters content where the value is not equal to the specified value.
    YearToDate
    Filters content where the date is within the current year-to-date period.
    Yesterday
    Filters content where the date is yesterday.

  • Method Summary

    Modifier and Type
    Method
    Description
    static PivotFilterType
    forValue(int value)
     
    int
    getValue()
     
    static PivotFilterType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PivotFilterType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    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

    • CaptionBeginsWith

      public static final PivotFilterType CaptionBeginsWith
      Filters the data where the caption starts with the specified value.

    • CaptionBetween

      public static final PivotFilterType CaptionBetween
      Filters the data where the caption is between the specified values.

    • CaptionContains

      public static final PivotFilterType CaptionContains
      Filters the data where the caption contains the specified value.

    • CaptionEndsWith

      public static final PivotFilterType CaptionEndsWith
      Filters the data where the caption ends with the specified value.

    • CaptionEqual

      public static final PivotFilterType CaptionEqual
      Filters the data where the caption is equal to the specified value.

    • CaptionGreaterThan

      public static final PivotFilterType CaptionGreaterThan
      Filters the data where the caption is greater than the specified value.

    • CaptionGreaterThanOrEqual

      public static final PivotFilterType CaptionGreaterThanOrEqual
      Filters the data where the caption is greater than or equal to the specified value.

    • CaptionLessThan

      public static final PivotFilterType CaptionLessThan
      Filters the data where the caption is less than the specified value.

    • CaptionLessThanOrEqual

      public static final PivotFilterType CaptionLessThanOrEqual
      Filters the data where the caption is less than or equal to the specified value.

    • CaptionNotBeginsWith

      public static final PivotFilterType CaptionNotBeginsWith
      Filters the data where the caption does not start with the specified value.

    • CaptionNotBetween

      public static final PivotFilterType CaptionNotBetween
      Filters the data where the caption is not between the specified values.

    • CaptionNotContains

      public static final PivotFilterType CaptionNotContains
      Filters the data where the caption does not contain the specified value.

    • CaptionNotEndsWith

      public static final PivotFilterType CaptionNotEndsWith
      Filters the data where the caption does not end with the specified value.

    • CaptionNotEqual

      public static final PivotFilterType CaptionNotEqual
      Filters the data where the caption is not equal to the specified value.

    • DateBetween

      public static final PivotFilterType DateBetween
      Filters the data where the date is between the specified values.

    • DateEqual

      public static final PivotFilterType DateEqual
      Filters the data where the date is equal to the specified value.

    • DateNewerThan

      public static final PivotFilterType DateNewerThan
      Filters the data where the date is newer than the specified value.

    • DateNewerThanOrEqual

      public static final PivotFilterType DateNewerThanOrEqual
      Filters the data where the date is newer than or equal to the specified value.

    • DateNotBetween

      public static final PivotFilterType DateNotBetween
      Filters the data where the date is not between the specified values.

    • DateNotEqual

      public static final PivotFilterType DateNotEqual
      Filters the data where the date is not equal to the specified value.

    • DateOlderThan

      public static final PivotFilterType DateOlderThan
      Filters the data where the date is older than the specified value.

    • DateOlderThanOrEqual

      public static final PivotFilterType DateOlderThanOrEqual
      Filters the data where the date is older than or equal to the specified value.

    • LastMonth

      public static final PivotFilterType LastMonth
      Filters the data for the last month.

    • LastQuarter

      public static final PivotFilterType LastQuarter
      Filters the data for the last quarter.

    • LastWeek

      public static final PivotFilterType LastWeek
      Filters the data for the last week.

    • LastYear

      public static final PivotFilterType LastYear
      Filters the data for the last year.

    • M1

      public static final PivotFilterType M1
      Filters the data for January.

    • M2

      public static final PivotFilterType M2
      Filters the data for February.

    • M3

      public static final PivotFilterType M3
      Filters the data for March.

    • M4

      public static final PivotFilterType M4
      Filters the data for April.

    • M5

      public static final PivotFilterType M5
      Filters the data for May.

    • M6

      public static final PivotFilterType M6
      Filters the data for June.

    • M7

      public static final PivotFilterType M7
      Filters the data for July.

    • M8

      public static final PivotFilterType M8
      Filters the data for August.

    • M9

      public static final PivotFilterType M9
      Filters the data for September.

    • M10

      public static final PivotFilterType M10
      Filters the data for October.

    • M11

      public static final PivotFilterType M11
      Filters the data for November.

    • M12

      public static final PivotFilterType M12
      Filters the data for December.

    • NextMonth

      public static final PivotFilterType NextMonth
      Filters the data for the next month.

    • NextQuarter

      public static final PivotFilterType NextQuarter
      Filters the data for the next quarter.

    • NextWeek

      public static final PivotFilterType NextWeek
      Filters the data for the next week.

    • NextYear

      public static final PivotFilterType NextYear
      Filters the data for the next year.

    • Q1

      public static final PivotFilterType Q1
      Filters the data for the first quarter.

    • Q2

      public static final PivotFilterType Q2
      Filters the data for the second quarter.

    • Q3

      public static final PivotFilterType Q3
      Filters the data for the third quarter.

    • Q4

      public static final PivotFilterType Q4
      Filters the data for the fourth quarter.

    • ThisMonth

      public static final PivotFilterType ThisMonth
      Filters the data for the current month.

    • ThisQuarter

      public static final PivotFilterType ThisQuarter
      Filters the data for the current quarter.

    • ThisWeek

      public static final PivotFilterType ThisWeek
      Filters the data for the current week.

    • ThisYear

      public static final PivotFilterType ThisYear
      Filters the data for the current year.

    • Today

      public static final PivotFilterType Today
      Filters the data for today.

    • Tomorrow

      public static final PivotFilterType Tomorrow
      Filters the data for tomorrow.

    • ValueBetween

      public static final PivotFilterType ValueBetween
      Filters the data where the value is between the specified values.

    • ValueEqual

      public static final PivotFilterType ValueEqual
      Filters the data where the value is equal to the specified value.

    • ValueGreaterThan

      public static final PivotFilterType ValueGreaterThan
      Filters the data where the value is greater than the specified value.

    • ValueGreaterThanOrEqual

      public static final PivotFilterType ValueGreaterThanOrEqual
      Filters the data where the value is greater than or equal to the specified value.

    • ValueLessThan

      public static final PivotFilterType ValueLessThan
      Filters the data where the value is less than the specified value.

    • ValueLessThanOrEqual

      public static final PivotFilterType ValueLessThanOrEqual
      Filters content where the value is less than or equal to the specified value.

    • ValueNotBetween

      public static final PivotFilterType ValueNotBetween
      Filters content where the value is not between the specified values (inclusive).

    • ValueNotEqual

      public static final PivotFilterType ValueNotEqual
      Filters content where the value is not equal to the specified value.

    • YearToDate

      public static final PivotFilterType YearToDate
      Filters content where the date is within the current year-to-date period.

    • Yesterday

      public static final PivotFilterType Yesterday
      Filters content where the date is yesterday.

    • Percent

      public static final PivotFilterType Percent
      Filters top/bottom items that comprise not less than the specified percent of the total of the field values.

    • Sum

      public static final PivotFilterType Sum
      Filters top/bottom items that comprise not less than the specified sum of the values.

    • Count

      public static final PivotFilterType Count
      Filters the specified number of items containing top/bottom values.

  • Method Details

    • values

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

    • getValue

      public int getValue()

    • forValue

      public static PivotFilterType forValue(int value)