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

Class DataLabel

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DataLabel
extends GenericJson

Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.

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

Method Summary

Modifier and Type	Method and Description
DataLabel	clone()
ChartData	getCustomLabelData() Data to use for custom labels.
String	getPlacement() The placement of the data label relative to the labeled data.
TextFormat	getTextFormat() The text format used for the data label.
String	getType() The type of the data label.
DataLabel	set(String fieldName, Object value)
DataLabel	setCustomLabelData(ChartData customLabelData) Data to use for custom labels.
DataLabel	setPlacement(String placement) The placement of the data label relative to the labeled data.
DataLabel	setTextFormat(TextFormat textFormat) The text format used for the data label.
DataLabel	setType(String type) The type of the data label.

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

DataLabel

public DataLabel()

Method Detail

getCustomLabelData

public ChartData getCustomLabelData()

Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from the next column in the source data. For example, if the series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8.

Returns:

value or null for none

setCustomLabelData

public DataLabel setCustomLabelData(ChartData customLabelData)

Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from the next column in the source data. For example, if the series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8.

Parameters:

customLabelData - customLabelData or null for none

getPlacement

public String getPlacement()

The placement of the data label relative to the labeled data.

Returns:

value or null for none

setPlacement

public DataLabel setPlacement(String placement)

The placement of the data label relative to the labeled data.

Parameters:

placement - placement or null for none

getTextFormat

public TextFormat getTextFormat()

The text format used for the data label. The link field is not supported.

Returns:

value or null for none

setTextFormat

public DataLabel setTextFormat(TextFormat textFormat)

The text format used for the data label. The link field is not supported.

Parameters:

textFormat - textFormat or null for none

getType

public String getType()

The type of the data label.

Returns:

value or null for none

setType

public DataLabel setType(String type)

The type of the data label.

Parameters:

type - type or null for none

set

public DataLabel set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public DataLabel clone()

Overrides:

clone in class GenericJson