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 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: http://code.google.com/p/google-http-java-client/wiki/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
BasicChartSpec()

Method Summary

Methods

Modifier and Type	Method and Description
BasicChartSpec	clone()
List<BasicChartAxis>	getAxis() The axis on the chart.
String	getChartType() The type of the chart.
List<BasicChartDomain>	getDomains() The domain of data this is charting.
Integer	getHeaderCount() The number of rows or columns in the data that are "headers".
String	getLegendPosition() The position of the chart legend.
List<BasicChartSeries>	getSeries() The data this chart is visualizing.
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	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	setLegendPosition(String legendPosition) The position of the chart legend.
BasicChartSpec	setSeries(List<BasicChartSeries> series) The data this chart is visualizing.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

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

getDomains

public List<BasicChartDomain> getDomains()

The domain of data this is charting. Only a single domain is currently 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 currently 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

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

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

set

public BasicChartSpec set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public BasicChartSpec clone()

Overrides:

clone in class GenericJson