TreemapChartSpec (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.TreemapChartSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TreemapChartSpec
extends com.google.api.client.json.GenericJson
```
A Treemap 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

TreemapChartSpec()

Constructors
Constructor and Description
`TreemapChartSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TreemapChartSpec`	`clone()`
`ChartData`	`getColorData()` The data that determines the background color of each treemap data cell.
`TreemapChartColorScale`	`getColorScale()` The color scale for data cells in the treemap chart.
`Color`	`getHeaderColor()` The background color for header cells.
`ColorStyle`	`getHeaderColorStyle()` The background color for header cells.
`Boolean`	`getHideTooltips()` True to hide tooltips.
`Integer`	`getHintedLevels()` The number of additional data levels beyond the labeled levels to be shown on the treemap chart.
`ChartData`	`getLabels()` The data that contains the treemap cell labels.
`Integer`	`getLevels()` The number of data levels to show on the treemap chart.
`Double`	`getMaxValue()` The maximum possible data value.
`Double`	`getMinValue()` The minimum possible data value.
`ChartData`	`getParentLabels()` The data the contains the treemap cells' parent labels.
`ChartData`	`getSizeData()` The data that determines the size of each treemap data cell.
`TextFormat`	`getTextFormat()` The text format for all labels on the chart.
`TreemapChartSpec`	`set(String fieldName, Object value)`
`TreemapChartSpec`	`setColorData(ChartData colorData)` The data that determines the background color of each treemap data cell.
`TreemapChartSpec`	`setColorScale(TreemapChartColorScale colorScale)` The color scale for data cells in the treemap chart.
`TreemapChartSpec`	`setHeaderColor(Color headerColor)` The background color for header cells.
`TreemapChartSpec`	`setHeaderColorStyle(ColorStyle headerColorStyle)` The background color for header cells.
`TreemapChartSpec`	`setHideTooltips(Boolean hideTooltips)` True to hide tooltips.
`TreemapChartSpec`	`setHintedLevels(Integer hintedLevels)` The number of additional data levels beyond the labeled levels to be shown on the treemap chart.
`TreemapChartSpec`	`setLabels(ChartData labels)` The data that contains the treemap cell labels.
`TreemapChartSpec`	`setLevels(Integer levels)` The number of data levels to show on the treemap chart.
`TreemapChartSpec`	`setMaxValue(Double maxValue)` The maximum possible data value.
`TreemapChartSpec`	`setMinValue(Double minValue)` The minimum possible data value.
`TreemapChartSpec`	`setParentLabels(ChartData parentLabels)` The data the contains the treemap cells' parent labels.
`TreemapChartSpec`	`setSizeData(ChartData sizeData)` The data that determines the size of each treemap data cell.
`TreemapChartSpec`	`setTextFormat(TextFormat textFormat)` The text format for all labels on the chart.

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
  - TreemapChartSpec
```
public TreemapChartSpec()
```
- Method Detail
  - getColorData
```
public ChartData getColorData()
```
    The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in this data map to data cell background colors.
    
    Returns:
    
    value or null for none
  - setColorData
```
public TreemapChartSpec setColorData(ChartData colorData)
```
    The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in this data map to data cell background colors.
    
    Parameters:
    
    colorData - colorData or null for none
  - getColorScale
```
public TreemapChartColorScale getColorScale()
```
    The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value will have minValueColor as their background color. Cells with color values greater than or equal to max_value will have maxValueColor as their background color. Cells with color values between min_value and max_value will have background colors on a gradient between minValueColor and maxValueColor, the midpoint of the gradient being midValueColor. Cells with missing or non-numeric color values will have noDataColor as their background color.
    
    Returns:
    
    value or null for none
  - setColorScale
```
public TreemapChartSpec setColorScale(TreemapChartColorScale colorScale)
```
    The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value will have minValueColor as their background color. Cells with color values greater than or equal to max_value will have maxValueColor as their background color. Cells with color values between min_value and max_value will have background colors on a gradient between minValueColor and maxValueColor, the midpoint of the gradient being midValueColor. Cells with missing or non-numeric color values will have noDataColor as their background color.
    
    Parameters:
    
    colorScale - colorScale or null for none
  - getHeaderColor
```
public Color getHeaderColor()
```
    The background color for header cells. Deprecated: Use header_color_style.
    
    Returns:
    
    value or null for none
  - setHeaderColor
```
public TreemapChartSpec setHeaderColor(Color headerColor)
```
    The background color for header cells. Deprecated: Use header_color_style.
    
    Parameters:
    
    headerColor - headerColor or null for none
  - getHeaderColorStyle
```
public ColorStyle getHeaderColorStyle()
```
    The background color for header cells. If header_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setHeaderColorStyle
```
public TreemapChartSpec setHeaderColorStyle(ColorStyle headerColorStyle)
```
    The background color for header cells. If header_color is also set, this field takes precedence.
    
    Parameters:
    
    headerColorStyle - headerColorStyle or null for none
  - getHideTooltips
```
public Boolean getHideTooltips()
```
    True to hide tooltips.
    
    Returns:
    
    value or null for none
  - setHideTooltips
```
public TreemapChartSpec setHideTooltips(Boolean hideTooltips)
```
    True to hide tooltips.
    
    Parameters:
    
    hideTooltips - hideTooltips or null for none
  - getHintedLevels
```
public Integer getHintedLevels()
```
    The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.
    
    Returns:
    
    value or null for none
  - setHintedLevels
```
public TreemapChartSpec setHintedLevels(Integer hintedLevels)
```
    The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.
    
    Parameters:
    
    hintedLevels - hintedLevels or null for none
  - getLabels
```
public ChartData getLabels()
```
    The data that contains the treemap cell labels.
    
    Returns:
    
    value or null for none
  - setLabels
```
public TreemapChartSpec setLabels(ChartData labels)
```
    The data that contains the treemap cell labels.
    
    Parameters:
    
    labels - labels or null for none
  - getLevels
```
public Integer getLevels()
```
    The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.
    
    Returns:
    
    value or null for none
  - setLevels
```
public TreemapChartSpec setLevels(Integer levels)
```
    The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.
    
    Parameters:
    
    levels - levels or null for none
  - getMaxValue
```
public Double getMaxValue()
```
    The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.
    
    Returns:
    
    value or null for none
  - setMaxValue
```
public TreemapChartSpec setMaxValue(Double maxValue)
```
    The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.
    
    Parameters:
    
    maxValue - maxValue or null for none
  - getMinValue
```
public Double getMinValue()
```
    The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.
    
    Returns:
    
    value or null for none
  - setMinValue
```
public TreemapChartSpec setMinValue(Double minValue)
```
    The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.
    
    Parameters:
    
    minValue - minValue or null for none
  - getParentLabels
```
public ChartData getParentLabels()
```
    The data the contains the treemap cells' parent labels.
    
    Returns:
    
    value or null for none
  - setParentLabels
```
public TreemapChartSpec setParentLabels(ChartData parentLabels)
```
    The data the contains the treemap cells' parent labels.
    
    Parameters:
    
    parentLabels - parentLabels or null for none
  - getSizeData
```
public ChartData getSizeData()
```
    The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background colors as well.
    
    Returns:
    
    value or null for none
  - setSizeData
```
public TreemapChartSpec setSizeData(ChartData sizeData)
```
    The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background colors as well.
    
    Parameters:
    
    sizeData - sizeData or null for none
  - getTextFormat
```
public TextFormat getTextFormat()
```
    The text format for all labels on the chart. The link field is not supported.
    
    Returns:
    
    value or null for none
  - setTextFormat
```
public TreemapChartSpec setTextFormat(TextFormat textFormat)
```
    The text format for all labels on the chart. The link field is not supported.
    
    Parameters:
    
    textFormat - textFormat or null for none
  - set
```
public TreemapChartSpec set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TreemapChartSpec clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TreemapChartSpec

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

TreemapChartSpec

Method Detail

getColorData

setColorData

getColorScale

setColorScale

getHeaderColor

setHeaderColor

getHeaderColorStyle

setHeaderColorStyle

getHideTooltips

setHideTooltips

getHintedLevels

setHintedLevels

getLabels

setLabels

getLevels

setLevels

getMaxValue

setMaxValue

getMinValue

setMinValue

getParentLabels

setParentLabels

getSizeData

setSizeData

getTextFormat

setTextFormat

set

clone