com.google.api.services.sheets.v4.model

Class HistogramChartSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HistogramChartSpec
extends com.google.api.client.json.GenericJson

A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.

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
HistogramChartSpec()

Method Summary

Modifier and Type	Method and Description
HistogramChartSpec	clone()
Double	getBucketSize() By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here.
String	getLegendPosition() The position of the chart legend.
Double	getOutlierPercentile() The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes.
List<HistogramSeries>	getSeries() The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.
Boolean	getShowItemDividers() Whether horizontal divider lines should be displayed between items in each column.
HistogramChartSpec	set(String fieldName, Object value)
HistogramChartSpec	setBucketSize(Double bucketSize) By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here.
HistogramChartSpec	setLegendPosition(String legendPosition) The position of the chart legend.
HistogramChartSpec	setOutlierPercentile(Double outlierPercentile) The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes.
HistogramChartSpec	setSeries(List<HistogramSeries> series) The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.
HistogramChartSpec	setShowItemDividers(Boolean showItemDividers) Whether horizontal divider lines should be displayed between items in each column.

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

HistogramChartSpec

public HistogramChartSpec()

Method Detail

getBucketSize

public Double getBucketSize()

By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.

Returns:

value or null for none

setBucketSize

public HistogramChartSpec setBucketSize(Double bucketSize)

By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.

Parameters:

bucketSize - bucketSize or null for none

getLegendPosition

public String getLegendPosition()

The position of the chart legend.

Returns:

value or null for none

setLegendPosition

public HistogramChartSpec setLegendPosition(String legendPosition)

The position of the chart legend.

Parameters:

legendPosition - legendPosition or null for none

getOutlierPercentile

public Double getOutlierPercentile()

The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.

Returns:

value or null for none

setOutlierPercentile

public HistogramChartSpec setOutlierPercentile(Double outlierPercentile)

The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.

Parameters:

outlierPercentile - outlierPercentile or null for none

getSeries

public List<HistogramSeries> getSeries()

The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.

Returns:

value or null for none

setSeries

public HistogramChartSpec setSeries(List<HistogramSeries> series)

The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.

Parameters:

series - series or null for none

getShowItemDividers

public Boolean getShowItemDividers()

Whether horizontal divider lines should be displayed between items in each column.

Returns:

value or null for none

setShowItemDividers

public HistogramChartSpec setShowItemDividers(Boolean showItemDividers)

Whether horizontal divider lines should be displayed between items in each column.

Parameters:

showItemDividers - showItemDividers or null for none

set

public HistogramChartSpec set(String fieldName,
                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public HistogramChartSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson