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

Class BaselineValueFormat

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BaselineValueFormat
extends GenericJson

Formatting options for baseline value.

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

Method Summary

Modifier and Type	Method and Description
BaselineValueFormat	clone()
String	getComparisonType() The comparison type of key value with baseline value.
String	getDescription() Description which is appended after the baseline value.
Color	getNegativeColor() Color to be used, in case baseline value represents a negative change for key value.
ColorStyle	getNegativeColorStyle() Color to be used, in case baseline value represents a negative change for key value.
TextPosition	getPosition() Specifies the horizontal text positioning of baseline value.
Color	getPositiveColor() Color to be used, in case baseline value represents a positive change for key value.
ColorStyle	getPositiveColorStyle() Color to be used, in case baseline value represents a positive change for key value.
TextFormat	getTextFormat() Text formatting options for baseline value.
BaselineValueFormat	set(String fieldName, Object value)
BaselineValueFormat	setComparisonType(String comparisonType) The comparison type of key value with baseline value.
BaselineValueFormat	setDescription(String description) Description which is appended after the baseline value.
BaselineValueFormat	setNegativeColor(Color negativeColor) Color to be used, in case baseline value represents a negative change for key value.
BaselineValueFormat	setNegativeColorStyle(ColorStyle negativeColorStyle) Color to be used, in case baseline value represents a negative change for key value.
BaselineValueFormat	setPosition(TextPosition position) Specifies the horizontal text positioning of baseline value.
BaselineValueFormat	setPositiveColor(Color positiveColor) Color to be used, in case baseline value represents a positive change for key value.
BaselineValueFormat	setPositiveColorStyle(ColorStyle positiveColorStyle) Color to be used, in case baseline value represents a positive change for key value.
BaselineValueFormat	setTextFormat(TextFormat textFormat) Text formatting options for baseline value.

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

BaselineValueFormat

public BaselineValueFormat()

Method Detail

getComparisonType

public String getComparisonType()

The comparison type of key value with baseline value.

Returns:

value or null for none

setComparisonType

public BaselineValueFormat setComparisonType(String comparisonType)

The comparison type of key value with baseline value.

Parameters:

comparisonType - comparisonType or null for none

getDescription

public String getDescription()

Description which is appended after the baseline value. This field is optional.

Returns:

value or null for none

setDescription

public BaselineValueFormat setDescription(String description)

Description which is appended after the baseline value. This field is optional.

Parameters:

description - description or null for none

getNegativeColor

public Color getNegativeColor()

Color to be used, in case baseline value represents a negative change for key value. This field is optional.

Returns:

value or null for none

setNegativeColor

public BaselineValueFormat setNegativeColor(Color negativeColor)

Color to be used, in case baseline value represents a negative change for key value. This field is optional.

Parameters:

negativeColor - negativeColor or null for none

getNegativeColorStyle

public ColorStyle getNegativeColorStyle()

Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negative_color is also set, this field takes precedence.

Returns:

value or null for none

setNegativeColorStyle

public BaselineValueFormat setNegativeColorStyle(ColorStyle negativeColorStyle)

Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negative_color is also set, this field takes precedence.

Parameters:

negativeColorStyle - negativeColorStyle or null for none

getPosition

public TextPosition getPosition()

Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.

Returns:

value or null for none

setPosition

public BaselineValueFormat setPosition(TextPosition position)

Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.

Parameters:

position - position or null for none

getPositiveColor

public Color getPositiveColor()

Color to be used, in case baseline value represents a positive change for key value. This field is optional.

Returns:

value or null for none

setPositiveColor

public BaselineValueFormat setPositiveColor(Color positiveColor)

Color to be used, in case baseline value represents a positive change for key value. This field is optional.

Parameters:

positiveColor - positiveColor or null for none

getPositiveColorStyle

public ColorStyle getPositiveColorStyle()

Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positive_color is also set, this field takes precedence.

Returns:

value or null for none

setPositiveColorStyle

public BaselineValueFormat setPositiveColorStyle(ColorStyle positiveColorStyle)

Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positive_color is also set, this field takes precedence.

Parameters:

positiveColorStyle - positiveColorStyle or null for none

getTextFormat

public TextFormat getTextFormat()

Text formatting options for baseline value. The link field is not supported.

Returns:

value or null for none

setTextFormat

public BaselineValueFormat setTextFormat(TextFormat textFormat)

Text formatting options for baseline value. The link field is not supported.

Parameters:

textFormat - textFormat or null for none

set

public BaselineValueFormat set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public BaselineValueFormat clone()

Overrides:

clone in class GenericJson