BasicChartSpec (Google Sheets API v4 (Rev. 545) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.BasicChartSpec

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

BasicChartSpec()

Constructors
Constructor and Description
`BasicChartSpec()`

Method Summary

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

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

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 java.util.List<BasicChartAxis> getAxis()
```
    The axis on the chart.
    
    Returns:
    
    value or null for none
  - setAxis
```
public BasicChartSpec setAxis(java.util.List<BasicChartAxis> axis)
```
    The axis on the chart.
    
    Parameters:
    
    axis - axis or null for none
  - getChartType
```
public java.lang.String getChartType()
```
    The type of the chart.
    
    Returns:
    
    value or null for none
  - setChartType
```
public BasicChartSpec setChartType(java.lang.String chartType)
```
    The type of the chart.
    
    Parameters:
    
    chartType - chartType or null for none
  - getCompareMode
```
public java.lang.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(java.lang.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 java.util.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(java.util.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getLegendPosition()
```
    The position of the chart legend.
    
    Returns:
    
    value or null for none
  - setLegendPosition
```
public BasicChartSpec setLegendPosition(java.lang.String legendPosition)
```
    The position of the chart legend.
    
    Parameters:
    
    legendPosition - legendPosition or null for none
  - getLineSmoothing
```
public java.lang.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(java.lang.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 java.util.List<BasicChartSeries> getSeries()
```
    The data this chart is visualizing.
    
    Returns:
    
    value or null for none
  - setSeries
```
public BasicChartSpec setSeries(java.util.List<BasicChartSeries> series)
```
    The data this chart is visualizing.
    
    Parameters:
    
    series - series or null for none
  - getStackedType
```
public java.lang.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(java.lang.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 java.lang.Boolean getThreeDimensional()
```
    True to make the chart 3D. Applies to Bar and Column charts.
    
    Returns:
    
    value or null for none
  - setThreeDimensional
```
public BasicChartSpec setThreeDimensional(java.lang.Boolean threeDimensional)
```
    True to make the chart 3D. Applies to Bar and Column charts.
    
    Parameters:
    
    threeDimensional - threeDimensional or null for none
  - set
```
public BasicChartSpec set(java.lang.String fieldName,
                          java.lang.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

Google Sheets API v4 (revision 545)

Class BasicChartSpec

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BasicChartSpec

Method Detail

getAxis

setAxis

getChartType

setChartType

getCompareMode

setCompareMode

getDomains

setDomains

getHeaderCount

setHeaderCount

getInterpolateNulls

setInterpolateNulls

getLegendPosition

setLegendPosition

getLineSmoothing

setLineSmoothing

getSeries

setSeries

getStackedType

setStackedType

getThreeDimensional

setThreeDimensional

set

clone