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

Class BasicChartSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The specification for a basic chart. See BasicChartType for the list of charts this supports.

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

Method Summary

Modifier and Type	Method and Description
BasicChartSpec	clone()
List<BasicChartAxis>	getAxis() The axis on the chart.
String	getChartType() The type of the chart.
String	getCompareMode() The behavior of tooltips and data highlighting when hovering on data and chart area.
List<BasicChartDomain>	getDomains() The domain of data this is charting.
Integer	getHeaderCount() The number of rows or columns in the data that are "headers".
Boolean	getInterpolateNulls() If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing).
String	getLegendPosition() The position of the chart legend.
Boolean	getLineSmoothing() Gets whether all lines should be rendered smooth or straight by default.
List<BasicChartSeries>	getSeries() The data this chart is visualizing.
String	getStackedType() The stacked type for charts that support vertical stacking.
Boolean	getThreeDimensional() True to make the chart 3D.
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.
BasicChartSpec	set(String fieldName, Object value)
BasicChartSpec	setAxis(List<BasicChartAxis> axis) The axis on the chart.
BasicChartSpec	setChartType(String chartType) The type of the chart.
BasicChartSpec	setCompareMode(String compareMode) The behavior of tooltips and data highlighting when hovering on data and chart area.
BasicChartSpec	setDomains(List<BasicChartDomain> domains) The domain of data this is charting.
BasicChartSpec	setHeaderCount(Integer headerCount) The number of rows or columns in the data that are "headers".
BasicChartSpec	setInterpolateNulls(Boolean interpolateNulls) If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing).
BasicChartSpec	setLegendPosition(String legendPosition) The position of the chart legend.
BasicChartSpec	setLineSmoothing(Boolean lineSmoothing) Gets whether all lines should be rendered smooth or straight by default.
BasicChartSpec	setSeries(List<BasicChartSeries> series) The data this chart is visualizing.
BasicChartSpec	setStackedType(String stackedType) The stacked type for charts that support vertical stacking.
BasicChartSpec	setThreeDimensional(Boolean threeDimensional) True to make the chart 3D.
BasicChartSpec	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

BasicChartSpec

public BasicChartSpec()

Method Detail

getAxis

public List<BasicChartAxis> getAxis()

The axis on the chart.

Returns:

value or null for none

setAxis

public BasicChartSpec setAxis(List<BasicChartAxis> axis)

The axis on the chart.

Parameters:

axis - axis or null for none

getChartType

public String getChartType()

The type of the chart.

Returns:

value or null for none

setChartType

public BasicChartSpec setChartType(String chartType)

The type of the chart.

Parameters:

chartType - chartType or null for none

getCompareMode

public String getCompareMode()

The behavior of tooltips and data highlighting when hovering on data and chart area.

Returns:

value or null for none

setCompareMode

public BasicChartSpec setCompareMode(String compareMode)

The behavior of tooltips and data highlighting when hovering on data and chart area.

Parameters:

compareMode - compareMode or null for none

getDomains

public List<BasicChartDomain> getDomains()

The domain of data this is charting. Only a single domain is supported.

Returns:

value or null for none

setDomains

public BasicChartSpec setDomains(List<BasicChartDomain> domains)

The domain of data this is charting. Only a single domain is supported.

Parameters:

domains - domains or null for none

getHeaderCount

public Integer getHeaderCount()

The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)

Returns:

value or null for none

setHeaderCount

public BasicChartSpec setHeaderCount(Integer headerCount)

The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)

Parameters:

headerCount - headerCount or null for none

getInterpolateNulls

public Boolean getInterpolateNulls()

If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.

Returns:

value or null for none

setInterpolateNulls

public BasicChartSpec setInterpolateNulls(Boolean interpolateNulls)

If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.

Parameters:

interpolateNulls - interpolateNulls or null for none

getLegendPosition

public String getLegendPosition()

The position of the chart legend.

Returns:

value or null for none

setLegendPosition

public BasicChartSpec setLegendPosition(String legendPosition)

The position of the chart legend.

Parameters:

legendPosition - legendPosition or null for none

getLineSmoothing

public Boolean getLineSmoothing()

Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.

Returns:

value or null for none

setLineSmoothing

public BasicChartSpec setLineSmoothing(Boolean lineSmoothing)

Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.

Parameters:

lineSmoothing - lineSmoothing or null for none

getSeries

public List<BasicChartSeries> getSeries()

The data this chart is visualizing.

Returns:

value or null for none

setSeries

public BasicChartSpec setSeries(List<BasicChartSeries> series)

The data this chart is visualizing.

Parameters:

series - series or null for none

getStackedType

public String getStackedType()

The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.

Returns:

value or null for none

setStackedType

public BasicChartSpec setStackedType(String stackedType)

The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.

Parameters:

stackedType - stackedType or null for none

getThreeDimensional

public Boolean getThreeDimensional()

True to make the chart 3D. Applies to Bar and Column charts.

Returns:

value or null for none

setThreeDimensional

public BasicChartSpec setThreeDimensional(Boolean threeDimensional)

True to make the chart 3D. Applies to Bar and Column charts.

Parameters:

threeDimensional - threeDimensional 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. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and stacked_type is either STACKED or PERCENT_STACKED. In addition, for COMBO, this will only be supported if there is only one type of stackable series type or one type has more series than the others and each of the other types have no more than one series. For example, if a chart has two stacked bar series and one area series, the total data labels will be supported. If it has three bar series and two area series, total data labels are not allowed. Neither CUSTOM nor placement can be set on the total_data_label.

Returns:

value or null for none

setTotalDataLabel

public BasicChartSpec 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. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and stacked_type is either STACKED or PERCENT_STACKED. In addition, for COMBO, this will only be supported if there is only one type of stackable series type or one type has more series than the others and each of the other types have no more than one series. For example, if a chart has two stacked bar series and one area series, the total data labels will be supported. If it has three bar series and two area series, total data labels are not allowed. Neither CUSTOM nor placement can be set on the total_data_label.

Parameters:

totalDataLabel - totalDataLabel or null for none

set

public BasicChartSpec set(String fieldName,
                          Object value)

Overrides:

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

clone

public BasicChartSpec clone()

Overrides:

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