ChartSpec (Google Sheets API v4-rev20241008-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,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
  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

ChartSpec()

Constructors
Constructor and Description
`ChartSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChartSpec`	`clone()`
`String`	`getAltText()` The alternative text that describes the chart.
`Color`	`getBackgroundColor()` The background color of the entire chart.
`ColorStyle`	`getBackgroundColorStyle()` 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.
`DataSourceChartProperties`	`getDataSourceChartProperties()` If present, the field contains data source chart specific properties.
`List<FilterSpec>`	`getFilterSpecs()` The filters applied to the source data of the chart.
`String`	`getFontName()` The name of the font to use by default for all chart text (e.g.
`String`	`getHiddenDimensionStrategy()` Determines how the charts will use hidden rows or columns.
`HistogramChartSpec`	`getHistogramChart()` A histogram chart specification.
`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.
`ScorecardChartSpec`	`getScorecardChart()` A scorecard chart specification.
`List<SortSpec>`	`getSortSpecs()` The order to sort the chart data by.
`String`	`getSubtitle()` The subtitle of the chart.
`TextFormat`	`getSubtitleTextFormat()` The subtitle text format.
`TextPosition`	`getSubtitleTextPosition()` The subtitle text position.
`String`	`getTitle()` The title of the chart.
`TextFormat`	`getTitleTextFormat()` The title text format.
`TextPosition`	`getTitleTextPosition()` The title text position.
`TreemapChartSpec`	`getTreemapChart()` A treemap chart specification.
`WaterfallChartSpec`	`getWaterfallChart()` A waterfall chart specification.
`ChartSpec`	`set(String fieldName, Object value)`
`ChartSpec`	`setAltText(String altText)` The alternative text that describes the chart.
`ChartSpec`	`setBackgroundColor(Color backgroundColor)` The background color of the entire chart.
`ChartSpec`	`setBackgroundColorStyle(ColorStyle backgroundColorStyle)` 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`	`setDataSourceChartProperties(DataSourceChartProperties dataSourceChartProperties)` If present, the field contains data source chart specific properties.
`ChartSpec`	`setFilterSpecs(List<FilterSpec> filterSpecs)` The filters applied to the source data of the chart.
`ChartSpec`	`setFontName(String fontName)` The name of the font to use by default for all chart text (e.g.
`ChartSpec`	`setHiddenDimensionStrategy(String hiddenDimensionStrategy)` Determines how the charts will use hidden rows or columns.
`ChartSpec`	`setHistogramChart(HistogramChartSpec histogramChart)` A histogram chart specification.
`ChartSpec`	`setMaximized(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`	`setScorecardChart(ScorecardChartSpec scorecardChart)` A scorecard chart specification.
`ChartSpec`	`setSortSpecs(List<SortSpec> sortSpecs)` The order to sort the chart data by.
`ChartSpec`	`setSubtitle(String subtitle)` The subtitle of the chart.
`ChartSpec`	`setSubtitleTextFormat(TextFormat subtitleTextFormat)` The subtitle text format.
`ChartSpec`	`setSubtitleTextPosition(TextPosition subtitleTextPosition)` The subtitle text position.
`ChartSpec`	`setTitle(String title)` The title of the chart.
`ChartSpec`	`setTitleTextFormat(TextFormat titleTextFormat)` The title text format.
`ChartSpec`	`setTitleTextPosition(TextPosition titleTextPosition)` The title text position.
`ChartSpec`	`setTreemapChart(TreemapChartSpec treemapChart)` A treemap chart specification.
`ChartSpec`	`setWaterfallChart(WaterfallChartSpec waterfallChart)` A waterfall chart specification.

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
  - ChartSpec
```
public ChartSpec()
```
- Method Detail
  - getAltText
```
public String getAltText()
```
    The alternative text that describes the chart. This is often used for accessibility.
    
    Returns:
    
    value or null for none
  - setAltText
```
public ChartSpec setAltText(String altText)
```
    The alternative text that describes the chart. This is often used for accessibility.
    
    Parameters:
    
    altText - altText or null for none
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
    
    Returns:
    
    value or null for none
  - setBackgroundColor
```
public ChartSpec setBackgroundColor(Color backgroundColor)
```
    The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
    
    Parameters:
    
    backgroundColor - backgroundColor or null for none
  - getBackgroundColorStyle
```
public ColorStyle getBackgroundColorStyle()
```
    The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setBackgroundColorStyle
```
public ChartSpec setBackgroundColorStyle(ColorStyle backgroundColorStyle)
```
    The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
    
    Parameters:
    
    backgroundColorStyle - backgroundColorStyle 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
  - getDataSourceChartProperties
```
public DataSourceChartProperties getDataSourceChartProperties()
```
    If present, the field contains data source chart specific properties.
    
    Returns:
    
    value or null for none
  - setDataSourceChartProperties
```
public ChartSpec setDataSourceChartProperties(DataSourceChartProperties dataSourceChartProperties)
```
    If present, the field contains data source chart specific properties.
    
    Parameters:
    
    dataSourceChartProperties - dataSourceChartProperties or null for none
  - getFilterSpecs
```
public List<FilterSpec> getFilterSpecs()
```
    The filters applied to the source data of the chart. Only supported for data source charts.
    
    Returns:
    
    value or null for none
  - setFilterSpecs
```
public ChartSpec setFilterSpecs(List<FilterSpec> filterSpecs)
```
    The filters applied to the source data of the chart. Only supported for data source charts.
    
    Parameters:
    
    filterSpecs - filterSpecs or null for none
  - getFontName
```
public 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(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 String getHiddenDimensionStrategy()
```
    Determines how the charts will use hidden rows or columns.
    
    Returns:
    
    value or null for none
  - setHiddenDimensionStrategy
```
public ChartSpec setHiddenDimensionStrategy(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 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(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
  - getScorecardChart
```
public ScorecardChartSpec getScorecardChart()
```
    A scorecard chart specification.
    
    Returns:
    
    value or null for none
  - setScorecardChart
```
public ChartSpec setScorecardChart(ScorecardChartSpec scorecardChart)
```
    A scorecard chart specification.
    
    Parameters:
    
    scorecardChart - scorecardChart or null for none
  - getSortSpecs
```
public List<SortSpec> getSortSpecs()
```
    The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
    
    Returns:
    
    value or null for none
  - setSortSpecs
```
public ChartSpec setSortSpecs(List<SortSpec> sortSpecs)
```
    The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
    
    Parameters:
    
    sortSpecs - sortSpecs or null for none
  - getSubtitle
```
public String getSubtitle()
```
    The subtitle of the chart.
    
    Returns:
    
    value or null for none
  - setSubtitle
```
public ChartSpec setSubtitle(String subtitle)
```
    The subtitle of the chart.
    
    Parameters:
    
    subtitle - subtitle or null for none
  - getSubtitleTextFormat
```
public TextFormat getSubtitleTextFormat()
```
    The subtitle text format. Strikethrough, underline, and link are not supported.
    
    Returns:
    
    value or null for none
  - setSubtitleTextFormat
```
public ChartSpec setSubtitleTextFormat(TextFormat subtitleTextFormat)
```
    The subtitle text format. Strikethrough, underline, and link are not supported.
    
    Parameters:
    
    subtitleTextFormat - subtitleTextFormat or null for none
  - getSubtitleTextPosition
```
public TextPosition getSubtitleTextPosition()
```
    The subtitle text position. This field is optional.
    
    Returns:
    
    value or null for none
  - setSubtitleTextPosition
```
public ChartSpec setSubtitleTextPosition(TextPosition subtitleTextPosition)
```
    The subtitle text position. This field is optional.
    
    Parameters:
    
    subtitleTextPosition - subtitleTextPosition or null for none
  - getTitle
```
public String getTitle()
```
    The title of the chart.
    
    Returns:
    
    value or null for none
  - setTitle
```
public ChartSpec setTitle(String title)
```
    The title of the chart.
    
    Parameters:
    
    title - title or null for none
  - getTitleTextFormat
```
public TextFormat getTitleTextFormat()
```
    The title text format. Strikethrough, underline, and link are not supported.
    
    Returns:
    
    value or null for none
  - setTitleTextFormat
```
public ChartSpec setTitleTextFormat(TextFormat titleTextFormat)
```
    The title text format. Strikethrough, underline, and link are not supported.
    
    Parameters:
    
    titleTextFormat - titleTextFormat or null for none
  - getTitleTextPosition
```
public TextPosition getTitleTextPosition()
```
    The title text position. This field is optional.
    
    Returns:
    
    value or null for none
  - setTitleTextPosition
```
public ChartSpec setTitleTextPosition(TextPosition titleTextPosition)
```
    The title text position. This field is optional.
    
    Parameters:
    
    titleTextPosition - titleTextPosition or null for none
  - getTreemapChart
```
public TreemapChartSpec getTreemapChart()
```
    A treemap chart specification.
    
    Returns:
    
    value or null for none
  - setTreemapChart
```
public ChartSpec setTreemapChart(TreemapChartSpec treemapChart)
```
    A treemap chart specification.
    
    Parameters:
    
    treemapChart - treemapChart or null for none
  - getWaterfallChart
```
public WaterfallChartSpec getWaterfallChart()
```
    A waterfall chart specification.
    
    Returns:
    
    value or null for none
  - setWaterfallChart
```
public ChartSpec setWaterfallChart(WaterfallChartSpec waterfallChart)
```
    A waterfall chart specification.
    
    Parameters:
    
    waterfallChart - waterfallChart or null for none
  - set
```
public ChartSpec set(String fieldName,
                     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

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

Methods inherited from interface java.util.Map

Constructor Detail

ChartSpec

Method Detail

getAltText

setAltText

getBackgroundColor

setBackgroundColor

getBackgroundColorStyle

setBackgroundColorStyle

getBasicChart

setBasicChart

getBubbleChart

setBubbleChart

getCandlestickChart

setCandlestickChart

getDataSourceChartProperties

setDataSourceChartProperties

getFilterSpecs

setFilterSpecs

getFontName

setFontName

getHiddenDimensionStrategy

setHiddenDimensionStrategy

getHistogramChart

setHistogramChart

getMaximized

setMaximized

getOrgChart

setOrgChart

getPieChart

setPieChart

getScorecardChart

setScorecardChart

getSortSpecs

setSortSpecs

getSubtitle

setSubtitle

getSubtitleTextFormat

setSubtitleTextFormat

getSubtitleTextPosition

setSubtitleTextPosition

getTitle

setTitle

getTitleTextFormat

setTitleTextFormat

getTitleTextPosition

setTitleTextPosition

getTreemapChart

setTreemapChart

getWaterfallChart

setWaterfallChart

set

clone