Package io.keikai.axyra.sheets

Enum Class PivotValueFilterType

java.lang.Object

java.lang.Enum<PivotValueFilterType>

io.keikai.axyra.sheets.PivotValueFilterType

All Implemented Interfaces:

Serializable, Comparable<PivotValueFilterType>, Constable

public enum PivotValueFilterType
extends Enum<PivotValueFilterType>

Value filter condition for a pivot row/column field — Excel's "Value Filters" menu (ECMA-376 Part 1 §18.18.72 ST_PivotFilterType, value subset). The condition compares each item's aggregate of a chosen values-area field to the threshold(s); items with no numeric aggregate always fail.

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
BETWEEN	Keeps items with low <= aggregate <= high; the only two-threshold condition.
EQUAL	Keeps items whose aggregate equals value, within a relative tolerance of one machine epsilon.
GREATER_THAN	Keeps items with aggregate > value.
GREATER_THAN_OR_EQUAL	Keeps items with aggregate >= value.
LESS_THAN	Keeps items with aggregate < value.
LESS_THAN_OR_EQUAL	Keeps items with aggregate <= value.
NOT_EQUAL	Keeps items whose aggregate differs from value by more than the EQUAL tolerance.

Method Summary

Modifier and Type	Method	Description
static PivotValueFilterType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PivotValueFilterType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()	The engine token passed 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

GREATER_THAN_OR_EQUAL

public static final PivotValueFilterType GREATER_THAN_OR_EQUAL

Keeps items with aggregate >= value.

GREATER_THAN

public static final PivotValueFilterType GREATER_THAN

Keeps items with aggregate > value.

LESS_THAN_OR_EQUAL

public static final PivotValueFilterType LESS_THAN_OR_EQUAL

Keeps items with aggregate <= value.

LESS_THAN

public static final PivotValueFilterType LESS_THAN

Keeps items with aggregate < value.

EQUAL

public static final PivotValueFilterType EQUAL

Keeps items whose aggregate equals value, within a relative tolerance of one machine epsilon.

NOT_EQUAL

public static final PivotValueFilterType NOT_EQUAL

Keeps items whose aggregate differs from value by more than the EQUAL tolerance.

BETWEEN

public static final PivotValueFilterType BETWEEN

Keeps items with low <= aggregate <= high; the only two-threshold condition. Set it with PivotTableView.setValueFilterBetween(java.lang.String, int, double, double), not PivotTableView.setValueFilter(java.lang.String, int, io.keikai.axyra.sheets.PivotValueFilterType, double).

Method Details

values

public static PivotValueFilterType[] 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 PivotValueFilterType 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 engine token passed across the FFI.