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

Class SlicerSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SlicerSpec
extends GenericJson

The specifications of a slicer.

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

Method Summary

Modifier and Type	Method and Description
SlicerSpec	clone()
Boolean	getApplyToPivotTables() True if the filter should apply to pivot tables.
Color	getBackgroundColor() The background color of the slicer.
ColorStyle	getBackgroundColorStyle() The background color of the slicer.
Integer	getColumnIndex() The column index in the data table on which the filter is applied to.
GridRange	getDataRange() The data range of the slicer.
FilterCriteria	getFilterCriteria() The filtering criteria of the slicer.
String	getHorizontalAlignment() The horizontal alignment of title in the slicer.
TextFormat	getTextFormat() The text format of title in the slicer.
String	getTitle() The title of the slicer.
SlicerSpec	set(String fieldName, Object value)
SlicerSpec	setApplyToPivotTables(Boolean applyToPivotTables) True if the filter should apply to pivot tables.
SlicerSpec	setBackgroundColor(Color backgroundColor) The background color of the slicer.
SlicerSpec	setBackgroundColorStyle(ColorStyle backgroundColorStyle) The background color of the slicer.
SlicerSpec	setColumnIndex(Integer columnIndex) The column index in the data table on which the filter is applied to.
SlicerSpec	setDataRange(GridRange dataRange) The data range of the slicer.
SlicerSpec	setFilterCriteria(FilterCriteria filterCriteria) The filtering criteria of the slicer.
SlicerSpec	setHorizontalAlignment(String horizontalAlignment) The horizontal alignment of title in the slicer.
SlicerSpec	setTextFormat(TextFormat textFormat) The text format of title in the slicer.
SlicerSpec	setTitle(String title) The title of the slicer.

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

SlicerSpec

public SlicerSpec()

Method Detail

getApplyToPivotTables

public Boolean getApplyToPivotTables()

True if the filter should apply to pivot tables. If not set, default to `True`.

Returns:

value or null for none

setApplyToPivotTables

public SlicerSpec setApplyToPivotTables(Boolean applyToPivotTables)

True if the filter should apply to pivot tables. If not set, default to `True`.

Parameters:

applyToPivotTables - applyToPivotTables or null for none

getBackgroundColor

public Color getBackgroundColor()

The background color of the slicer.

Returns:

value or null for none

setBackgroundColor

public SlicerSpec setBackgroundColor(Color backgroundColor)

The background color of the slicer.

Parameters:

backgroundColor - backgroundColor or null for none

getBackgroundColorStyle

public ColorStyle getBackgroundColorStyle()

The background color of the slicer. If background_color is also set, this field takes precedence.

Returns:

value or null for none

setBackgroundColorStyle

public SlicerSpec setBackgroundColorStyle(ColorStyle backgroundColorStyle)

The background color of the slicer. If background_color is also set, this field takes precedence.

Parameters:

backgroundColorStyle - backgroundColorStyle or null for none

getColumnIndex

public Integer getColumnIndex()

The column index in the data table on which the filter is applied to.

Returns:

value or null for none

setColumnIndex

public SlicerSpec setColumnIndex(Integer columnIndex)

The column index in the data table on which the filter is applied to.

Parameters:

columnIndex - columnIndex or null for none

getDataRange

public GridRange getDataRange()

The data range of the slicer.

Returns:

value or null for none

setDataRange

public SlicerSpec setDataRange(GridRange dataRange)

The data range of the slicer.

Parameters:

dataRange - dataRange or null for none

getFilterCriteria

public FilterCriteria getFilterCriteria()

The filtering criteria of the slicer.

Returns:

value or null for none

setFilterCriteria

public SlicerSpec setFilterCriteria(FilterCriteria filterCriteria)

The filtering criteria of the slicer.

Parameters:

filterCriteria - filterCriteria or null for none

getHorizontalAlignment

public String getHorizontalAlignment()

The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`

Returns:

value or null for none

setHorizontalAlignment

public SlicerSpec setHorizontalAlignment(String horizontalAlignment)

The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`

Parameters:

horizontalAlignment - horizontalAlignment or null for none

getTextFormat

public TextFormat getTextFormat()

The text format of title in the slicer. The link field is not supported.

Returns:

value or null for none

setTextFormat

public SlicerSpec setTextFormat(TextFormat textFormat)

The text format of title in the slicer. The link field is not supported.

Parameters:

textFormat - textFormat or null for none

getTitle

public String getTitle()

The title of the slicer.

Returns:

value or null for none

setTitle

public SlicerSpec setTitle(String title)

The title of the slicer.

Parameters:

title - title or null for none

set

public SlicerSpec set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public SlicerSpec clone()

Overrides:

clone in class GenericJson