com.google.api.services.sheets.v4.model

Class PivotFilterCriteria

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sheets.v4.model.PivotFilterCriteria

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PivotFilterCriteria
extends com.google.api.client.json.GenericJson

Criteria for showing/hiding rows in a pivot table.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PivotFilterCriteria()

Method Summary

Modifier and Type	Method and Description
PivotFilterCriteria	clone()
BooleanCondition	getCondition() A condition that must be true for values to be shown.
Boolean	getVisibleByDefault() Whether values are visible by default.
List<String>	getVisibleValues() Values that should be included.
PivotFilterCriteria	set(String fieldName, Object value)
PivotFilterCriteria	setCondition(BooleanCondition condition) A condition that must be true for values to be shown.
PivotFilterCriteria	setVisibleByDefault(Boolean visibleByDefault) Whether values are visible by default.
PivotFilterCriteria	setVisibleValues(List<String> visibleValues) Values that should be included.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PivotFilterCriteria

public PivotFilterCriteria()

Method Detail

getCondition

public BooleanCondition getCondition()

A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relative to the pivot table sheet. References are treated absolutely, so are not filled down the pivot table. For example, a condition value of `=A1` on "Pivot Table 1" is treated as `'Pivot Table 1'!$A$1`. The source data of the pivot table can be referenced by column header name. For example, if the source data has columns named "Revenue" and "Cost" and a condition is applied to the "Revenue" column with type `NUMBER_GREATER` and value `=Cost`, then only columns where "Revenue" > "Cost" are included.

Returns:

value or null for none

setCondition

public PivotFilterCriteria setCondition(BooleanCondition condition)

A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relative to the pivot table sheet. References are treated absolutely, so are not filled down the pivot table. For example, a condition value of `=A1` on "Pivot Table 1" is treated as `'Pivot Table 1'!$A$1`. The source data of the pivot table can be referenced by column header name. For example, if the source data has columns named "Revenue" and "Cost" and a condition is applied to the "Revenue" column with type `NUMBER_GREATER` and value `=Cost`, then only columns where "Revenue" > "Cost" are included.

Parameters:

condition - condition or null for none

getVisibleByDefault

public Boolean getVisibleByDefault()

Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.

Returns:

value or null for none

setVisibleByDefault

public PivotFilterCriteria setVisibleByDefault(Boolean visibleByDefault)

Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.

Parameters:

visibleByDefault - visibleByDefault or null for none

getVisibleValues

public List<String> getVisibleValues()

Values that should be included. Values not listed here are excluded.

Returns:

value or null for none

setVisibleValues

public PivotFilterCriteria setVisibleValues(List<String> visibleValues)

Values that should be included. Values not listed here are excluded.

Parameters:

visibleValues - visibleValues or null for none

set

public PivotFilterCriteria set(String fieldName,
                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PivotFilterCriteria clone()

Overrides:

clone in class com.google.api.client.json.GenericJson