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

Class WaterfallChartSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class WaterfallChartSpec
extends GenericJson

A waterfall chart.

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

Method Summary

Modifier and Type	Method and Description
WaterfallChartSpec	clone()
LineStyle	getConnectorLineStyle() The line style for the connector lines.
WaterfallChartDomain	getDomain() The domain data (horizontal axis) for the waterfall chart.
Boolean	getFirstValueIsTotal() True to interpret the first value as a total.
Boolean	getHideConnectorLines() True to hide connector lines between columns.
List<WaterfallChartSeries>	getSeries() The data this waterfall chart is visualizing.
String	getStackedType() The stacked type.
DataLabel	getTotalDataLabel() Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis.
WaterfallChartSpec	set(String fieldName, Object value)
WaterfallChartSpec	setConnectorLineStyle(LineStyle connectorLineStyle) The line style for the connector lines.
WaterfallChartSpec	setDomain(WaterfallChartDomain domain) The domain data (horizontal axis) for the waterfall chart.
WaterfallChartSpec	setFirstValueIsTotal(Boolean firstValueIsTotal) True to interpret the first value as a total.
WaterfallChartSpec	setHideConnectorLines(Boolean hideConnectorLines) True to hide connector lines between columns.
WaterfallChartSpec	setSeries(List<WaterfallChartSeries> series) The data this waterfall chart is visualizing.
WaterfallChartSpec	setStackedType(String stackedType) The stacked type.
WaterfallChartSpec	setTotalDataLabel(DataLabel totalDataLabel) Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis.

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

WaterfallChartSpec

public WaterfallChartSpec()

Method Detail

getConnectorLineStyle

public LineStyle getConnectorLineStyle()

The line style for the connector lines.

Returns:

value or null for none

setConnectorLineStyle

public WaterfallChartSpec setConnectorLineStyle(LineStyle connectorLineStyle)

The line style for the connector lines.

Parameters:

connectorLineStyle - connectorLineStyle or null for none

getDomain

public WaterfallChartDomain getDomain()

The domain data (horizontal axis) for the waterfall chart.

Returns:

value or null for none

setDomain

public WaterfallChartSpec setDomain(WaterfallChartDomain domain)

The domain data (horizontal axis) for the waterfall chart.

Parameters:

domain - domain or null for none

getFirstValueIsTotal

public Boolean getFirstValueIsTotal()

True to interpret the first value as a total.

Returns:

value or null for none

setFirstValueIsTotal

public WaterfallChartSpec setFirstValueIsTotal(Boolean firstValueIsTotal)

True to interpret the first value as a total.

Parameters:

firstValueIsTotal - firstValueIsTotal or null for none

getHideConnectorLines

public Boolean getHideConnectorLines()

True to hide connector lines between columns.

Returns:

value or null for none

setHideConnectorLines

public WaterfallChartSpec setHideConnectorLines(Boolean hideConnectorLines)

True to hide connector lines between columns.

Parameters:

hideConnectorLines - hideConnectorLines or null for none

getSeries

public List<WaterfallChartSeries> getSeries()

The data this waterfall chart is visualizing.

Returns:

value or null for none

setSeries

public WaterfallChartSpec setSeries(List<WaterfallChartSeries> series)

The data this waterfall chart is visualizing.

Parameters:

series - series or null for none

getStackedType

public String getStackedType()

The stacked type.

Returns:

value or null for none

setStackedType

public WaterfallChartSpec setStackedType(String stackedType)

The stacked type.

Parameters:

stackedType - stackedType or null for none

getTotalDataLabel

public DataLabel getTotalDataLabel()

Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label.

Returns:

value or null for none

setTotalDataLabel

public WaterfallChartSpec setTotalDataLabel(DataLabel totalDataLabel)

Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label.

Parameters:

totalDataLabel - totalDataLabel or null for none

set

public WaterfallChartSpec set(String fieldName,
                              Object value)

Overrides:

set in class GenericJson

clone

public WaterfallChartSpec clone()

Overrides:

clone in class GenericJson