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

Class BasicChartSeries

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BasicChartSeries
extends GenericJson

A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price".

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

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

Method Summary

Modifier and Type	Method and Description
BasicChartSeries	clone()
Color	getColor() The color for elements (such as bars, lines, and points) associated with this series.
ColorStyle	getColorStyle() The color for elements (such as bars, lines, and points) associated with this series.
DataLabel	getDataLabel() Information about the data labels for this series.
LineStyle	getLineStyle() The line style of this series.
PointStyle	getPointStyle() The style for points associated with this series.
ChartData	getSeries() The data being visualized in this chart series.
List<BasicSeriesDataPointStyleOverride>	getStyleOverrides() Style override settings for series data points.
String	getTargetAxis() The minor axis that will specify the range of values for this series.
String	getType() The type of this series.
BasicChartSeries	set(String fieldName, Object value)
BasicChartSeries	setColor(Color color) The color for elements (such as bars, lines, and points) associated with this series.
BasicChartSeries	setColorStyle(ColorStyle colorStyle) The color for elements (such as bars, lines, and points) associated with this series.
BasicChartSeries	setDataLabel(DataLabel dataLabel) Information about the data labels for this series.
BasicChartSeries	setLineStyle(LineStyle lineStyle) The line style of this series.
BasicChartSeries	setPointStyle(PointStyle pointStyle) The style for points associated with this series.
BasicChartSeries	setSeries(ChartData series) The data being visualized in this chart series.
BasicChartSeries	setStyleOverrides(List<BasicSeriesDataPointStyleOverride> styleOverrides) Style override settings for series data points.
BasicChartSeries	setTargetAxis(String targetAxis) The minor axis that will specify the range of values for this series.
BasicChartSeries	setType(String type) The type of this series.

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

BasicChartSeries

public BasicChartSeries()

Method Detail

getColor

public Color getColor()

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used.

Returns:

value or null for none

setColor

public BasicChartSeries setColor(Color color)

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used.

Parameters:

color - color or null for none

getColorStyle

public ColorStyle getColorStyle()

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence.

Returns:

value or null for none

setColorStyle

public BasicChartSeries setColorStyle(ColorStyle colorStyle)

The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence.

Parameters:

colorStyle - colorStyle or null for none

getDataLabel

public DataLabel getDataLabel()

Information about the data labels for this series.

Returns:

value or null for none

setDataLabel

public BasicChartSeries setDataLabel(DataLabel dataLabel)

Information about the data labels for this series.

Parameters:

dataLabel - dataLabel or null for none

getLineStyle

public LineStyle getLineStyle()

The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE.

Returns:

value or null for none

setLineStyle

public BasicChartSeries setLineStyle(LineStyle lineStyle)

The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE.

Parameters:

lineStyle - lineStyle or null for none

getPointStyle

public PointStyle getPointStyle()

The style for points associated with this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, a default point style is used.

Returns:

value or null for none

setPointStyle

public BasicChartSeries setPointStyle(PointStyle pointStyle)

The style for points associated with this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, a default point style is used.

Parameters:

pointStyle - pointStyle or null for none

getSeries

public ChartData getSeries()

The data being visualized in this chart series.

Returns:

value or null for none

setSeries

public BasicChartSeries setSeries(ChartData series)

The data being visualized in this chart series.

Parameters:

series - series or null for none

getStyleOverrides

public List<BasicSeriesDataPointStyleOverride> getStyleOverrides()

Style override settings for series data points.

Returns:

value or null for none

setStyleOverrides

public BasicChartSeries setStyleOverrides(List<BasicSeriesDataPointStyleOverride> styleOverrides)

Style override settings for series data points.

Parameters:

styleOverrides - styleOverrides or null for none

getTargetAxis

public String getTargetAxis()

The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.

Returns:

value or null for none

setTargetAxis

public BasicChartSeries setTargetAxis(String targetAxis)

The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.

Parameters:

targetAxis - targetAxis or null for none

getType

public String getType()

The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.

Returns:

value or null for none

setType

public BasicChartSeries setType(String type)

The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.

Parameters:

type - type or null for none

set

public BasicChartSeries set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public BasicChartSeries clone()

Overrides:

clone in class GenericJson