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

Class PivotValue

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.PivotValue

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PivotValue
extends GenericJson

The definition of how a value in a pivot table should be calculated.

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

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
PivotValue()

Method Summary

Modifier and Type	Method and Description
PivotValue	clone()
String	getCalculatedDisplayType() If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value.
DataSourceColumnReference	getDataSourceColumnReference() The reference to the data source column that this value reads from.
String	getFormula() A custom formula to calculate the value.
String	getName() A name to use for the value.
Integer	getSourceColumnOffset() The column offset of the source range that this value reads from.
String	getSummarizeFunction() A function to summarize the value.
PivotValue	set(String fieldName, Object value)
PivotValue	setCalculatedDisplayType(String calculatedDisplayType) If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value.
PivotValue	setDataSourceColumnReference(DataSourceColumnReference dataSourceColumnReference) The reference to the data source column that this value reads from.
PivotValue	setFormula(String formula) A custom formula to calculate the value.
PivotValue	setName(String name) A name to use for the value.
PivotValue	setSourceColumnOffset(Integer sourceColumnOffset) The column offset of the source range that this value reads from.
PivotValue	setSummarizeFunction(String summarizeFunction) A function to summarize the value.

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

PivotValue

public PivotValue()

Method Detail

getCalculatedDisplayType

public String getCalculatedDisplayType()

If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot table.

Returns:

value or null for none

setCalculatedDisplayType

public PivotValue setCalculatedDisplayType(String calculatedDisplayType)

If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot table.

Parameters:

calculatedDisplayType - calculatedDisplayType or null for none

getDataSourceColumnReference

public DataSourceColumnReference getDataSourceColumnReference()

The reference to the data source column that this value reads from.

Returns:

value or null for none

setDataSourceColumnReference

public PivotValue setDataSourceColumnReference(DataSourceColumnReference dataSourceColumnReference)

The reference to the data source column that this value reads from.

Parameters:

dataSourceColumnReference - dataSourceColumnReference or null for none

getFormula

public String getFormula()

A custom formula to calculate the value. The formula must start with an `=` character.

Returns:

value or null for none

setFormula

public PivotValue setFormula(String formula)

A custom formula to calculate the value. The formula must start with an `=` character.

Parameters:

formula - formula or null for none

getName

public String getName()

A name to use for the value.

Returns:

value or null for none

setName

public PivotValue setName(String name)

A name to use for the value.

Parameters:

name - name or null for none

getSourceColumnOffset

public Integer getSourceColumnOffset()

The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.

Returns:

value or null for none

setSourceColumnOffset

public PivotValue setSourceColumnOffset(Integer sourceColumnOffset)

The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.

Parameters:

sourceColumnOffset - sourceColumnOffset or null for none

getSummarizeFunction

public String getSummarizeFunction()

A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.

Returns:

value or null for none

setSummarizeFunction

public PivotValue setSummarizeFunction(String summarizeFunction)

A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.

Parameters:

summarizeFunction - summarizeFunction or null for none

set

public PivotValue set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public PivotValue clone()

Overrides:

clone in class GenericJson