ChartSpec (Google Sheets API v4 (Rev. 480) 1.22.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.ChartSpec

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ChartSpec
extends com.google.api.client.json.GenericJson
```
The specifications of a 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
  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

ChartSpec()

Constructors
Constructor and Description
`ChartSpec()`

Method Summary

Methods
Modifier and Type	Method and Description
`ChartSpec`	`clone()`
`Color`	`getBackgroundColor()` The background color of the entire chart.
`BasicChartSpec`	`getBasicChart()` A basic chart specification, can be one of many kinds of charts.
`BubbleChartSpec`	`getBubbleChart()` A bubble chart specification.
`CandlestickChartSpec`	`getCandlestickChart()` A candlestick chart specification.
`java.lang.String`	`getFontName()` The name of the font to use by default for all chart text (e.g.
`java.lang.String`	`getHiddenDimensionStrategy()` Determines how the charts will use hidden rows or columns.
`HistogramChartSpec`	`getHistogramChart()` A histogram chart specification.
`java.lang.Boolean`	`getMaximized()` True to make a chart fill the entire space in which it's rendered with minimum padding.
`OrgChartSpec`	`getOrgChart()` An org chart specification.
`PieChartSpec`	`getPieChart()` A pie chart specification.
`java.lang.String`	`getTitle()` The title of the chart.
`TextFormat`	`getTitleTextFormat()` The title text format.
`ChartSpec`	`set(java.lang.String fieldName, java.lang.Object value)`
`ChartSpec`	`setBackgroundColor(Color backgroundColor)` The background color of the entire chart.
`ChartSpec`	`setBasicChart(BasicChartSpec basicChart)` A basic chart specification, can be one of many kinds of charts.
`ChartSpec`	`setBubbleChart(BubbleChartSpec bubbleChart)` A bubble chart specification.
`ChartSpec`	`setCandlestickChart(CandlestickChartSpec candlestickChart)` A candlestick chart specification.
`ChartSpec`	`setFontName(java.lang.String fontName)` The name of the font to use by default for all chart text (e.g.
`ChartSpec`	`setHiddenDimensionStrategy(java.lang.String hiddenDimensionStrategy)` Determines how the charts will use hidden rows or columns.
`ChartSpec`	`setHistogramChart(HistogramChartSpec histogramChart)` A histogram chart specification.
`ChartSpec`	`setMaximized(java.lang.Boolean maximized)` True to make a chart fill the entire space in which it's rendered with minimum padding.
`ChartSpec`	`setOrgChart(OrgChartSpec orgChart)` An org chart specification.
`ChartSpec`	`setPieChart(PieChartSpec pieChart)` A pie chart specification.
`ChartSpec`	`setTitle(java.lang.String title)` The title of the chart.
`ChartSpec`	`setTitleTextFormat(TextFormat titleTextFormat)` The title text format.

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
  - ChartSpec
```
public ChartSpec()
```
- Method Detail
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    The background color of the entire chart. Not applicable to Org charts.
    
    Returns:
    value or null for none
  - setBackgroundColor
```
public ChartSpec setBackgroundColor(Color backgroundColor)
```
    The background color of the entire chart. Not applicable to Org charts.
    
    Parameters:
    backgroundColor - backgroundColor or null for none
  - getBasicChart
```
public BasicChartSpec getBasicChart()
```
    A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
    
    Returns:
    value or null for none
  - setBasicChart
```
public ChartSpec setBasicChart(BasicChartSpec basicChart)
```
    A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
    
    Parameters:
    basicChart - basicChart or null for none
  - getBubbleChart
```
public BubbleChartSpec getBubbleChart()
```
    A bubble chart specification.
    
    Returns:
    value or null for none
  - setBubbleChart
```
public ChartSpec setBubbleChart(BubbleChartSpec bubbleChart)
```
    A bubble chart specification.
    
    Parameters:
    bubbleChart - bubbleChart or null for none
  - getCandlestickChart
```
public CandlestickChartSpec getCandlestickChart()
```
    A candlestick chart specification.
    
    Returns:
    value or null for none
  - setCandlestickChart
```
public ChartSpec setCandlestickChart(CandlestickChartSpec candlestickChart)
```
    A candlestick chart specification.
    
    Parameters:
    candlestickChart - candlestickChart or null for none
  - getFontName
```
public java.lang.String getFontName()
```
    The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
    
    Returns:
    value or null for none
  - setFontName
```
public ChartSpec setFontName(java.lang.String fontName)
```
    The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
    
    Parameters:
    fontName - fontName or null for none
  - getHiddenDimensionStrategy
```
public java.lang.String getHiddenDimensionStrategy()
```
    Determines how the charts will use hidden rows or columns.
    
    Returns:
    value or null for none
  - setHiddenDimensionStrategy
```
public ChartSpec setHiddenDimensionStrategy(java.lang.String hiddenDimensionStrategy)
```
    Determines how the charts will use hidden rows or columns.
    
    Parameters:
    hiddenDimensionStrategy - hiddenDimensionStrategy or null for none
  - getHistogramChart
```
public HistogramChartSpec getHistogramChart()
```
    A histogram chart specification.
    
    Returns:
    value or null for none
  - setHistogramChart
```
public ChartSpec setHistogramChart(HistogramChartSpec histogramChart)
```
    A histogram chart specification.
    
    Parameters:
    histogramChart - histogramChart or null for none
  - getMaximized
```
public java.lang.Boolean getMaximized()
```
    True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
    
    Returns:
    value or null for none
  - setMaximized
```
public ChartSpec setMaximized(java.lang.Boolean maximized)
```
    True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
    
    Parameters:
    maximized - maximized or null for none
  - getOrgChart
```
public OrgChartSpec getOrgChart()
```
    An org chart specification.
    
    Returns:
    value or null for none
  - setOrgChart
```
public ChartSpec setOrgChart(OrgChartSpec orgChart)
```
    An org chart specification.
    
    Parameters:
    orgChart - orgChart or null for none
  - getPieChart
```
public PieChartSpec getPieChart()
```
    A pie chart specification.
    
    Returns:
    value or null for none
  - setPieChart
```
public ChartSpec setPieChart(PieChartSpec pieChart)
```
    A pie chart specification.
    
    Parameters:
    pieChart - pieChart or null for none
  - getTitle
```
public java.lang.String getTitle()
```
    The title of the chart.
    
    Returns:
    value or null for none
  - setTitle
```
public ChartSpec setTitle(java.lang.String title)
```
    The title of the chart.
    
    Parameters:
    title - title or null for none
  - getTitleTextFormat
```
public TextFormat getTitleTextFormat()
```
    The title text format. Strikethrough and underline are not supported.
    
    Returns:
    value or null for none
  - setTitleTextFormat
```
public ChartSpec setTitleTextFormat(TextFormat titleTextFormat)
```
    The title text format. Strikethrough and underline are not supported.
    
    Parameters:
    titleTextFormat - titleTextFormat or null for none
  - set
```
public ChartSpec set(java.lang.String fieldName,
            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ChartSpec clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Sheets API v4 (revision 480)

Class ChartSpec

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

Constructor Detail

ChartSpec

Method Detail

getBackgroundColor

setBackgroundColor

getBasicChart

setBasicChart

getBubbleChart

setBubbleChart

getCandlestickChart

setCandlestickChart

getFontName

setFontName

getHiddenDimensionStrategy

setHiddenDimensionStrategy

getHistogramChart

setHistogramChart

getMaximized

setMaximized

getOrgChart

setOrgChart

getPieChart

setPieChart

getTitle

setTitle

getTitleTextFormat

setTitleTextFormat

set

clone