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

Class ScorecardChartSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ScorecardChartSpec
extends GenericJson

A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.

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

Method Summary

Modifier and Type	Method and Description
ScorecardChartSpec	clone()
String	getAggregateType() The aggregation type for key and baseline chart data in scorecard chart.
ChartData	getBaselineValueData() The data for scorecard baseline value.
BaselineValueFormat	getBaselineValueFormat() Formatting options for baseline value.
ChartCustomNumberFormatOptions	getCustomFormatOptions() Custom formatting options for numeric key/baseline values in scorecard chart.
ChartData	getKeyValueData() The data for scorecard key value.
KeyValueFormat	getKeyValueFormat() Formatting options for key value.
String	getNumberFormatSource() The number format source used in the scorecard chart.
Double	getScaleFactor() Value to scale scorecard key and baseline value.
ScorecardChartSpec	set(String fieldName, Object value)
ScorecardChartSpec	setAggregateType(String aggregateType) The aggregation type for key and baseline chart data in scorecard chart.
ScorecardChartSpec	setBaselineValueData(ChartData baselineValueData) The data for scorecard baseline value.
ScorecardChartSpec	setBaselineValueFormat(BaselineValueFormat baselineValueFormat) Formatting options for baseline value.
ScorecardChartSpec	setCustomFormatOptions(ChartCustomNumberFormatOptions customFormatOptions) Custom formatting options for numeric key/baseline values in scorecard chart.
ScorecardChartSpec	setKeyValueData(ChartData keyValueData) The data for scorecard key value.
ScorecardChartSpec	setKeyValueFormat(KeyValueFormat keyValueFormat) Formatting options for key value.
ScorecardChartSpec	setNumberFormatSource(String numberFormatSource) The number format source used in the scorecard chart.
ScorecardChartSpec	setScaleFactor(Double scaleFactor) Value to scale scorecard key and 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

ScorecardChartSpec

public ScorecardChartSpec()

Method Detail

getAggregateType

public String getAggregateType()

The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optional.

Returns:

value or null for none

setAggregateType

public ScorecardChartSpec setAggregateType(String aggregateType)

The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optional.

Parameters:

aggregateType - aggregateType or null for none

getBaselineValueData

public ChartData getBaselineValueData()

The data for scorecard baseline value. This field is optional.

Returns:

value or null for none

setBaselineValueData

public ScorecardChartSpec setBaselineValueData(ChartData baselineValueData)

The data for scorecard baseline value. This field is optional.

Parameters:

baselineValueData - baselineValueData or null for none

getBaselineValueFormat

public BaselineValueFormat getBaselineValueFormat()

Formatting options for baseline value. This field is needed only if baseline_value_data is specified.

Returns:

value or null for none

setBaselineValueFormat

public ScorecardChartSpec setBaselineValueFormat(BaselineValueFormat baselineValueFormat)

Formatting options for baseline value. This field is needed only if baseline_value_data is specified.

Parameters:

baselineValueFormat - baselineValueFormat or null for none

getCustomFormatOptions

public ChartCustomNumberFormatOptions getCustomFormatOptions()

Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional.

Returns:

value or null for none

setCustomFormatOptions

public ScorecardChartSpec setCustomFormatOptions(ChartCustomNumberFormatOptions customFormatOptions)

Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional.

Parameters:

customFormatOptions - customFormatOptions or null for none

getKeyValueData

public ChartData getKeyValueData()

The data for scorecard key value.

Returns:

value or null for none

setKeyValueData

public ScorecardChartSpec setKeyValueData(ChartData keyValueData)

The data for scorecard key value.

Parameters:

keyValueData - keyValueData or null for none

getKeyValueFormat

public KeyValueFormat getKeyValueFormat()

Formatting options for key value.

Returns:

value or null for none

setKeyValueFormat

public ScorecardChartSpec setKeyValueFormat(KeyValueFormat keyValueFormat)

Formatting options for key value.

Parameters:

keyValueFormat - keyValueFormat or null for none

getNumberFormatSource

public String getNumberFormatSource()

The number format source used in the scorecard chart. This field is optional.

Returns:

value or null for none

setNumberFormatSource

public ScorecardChartSpec setNumberFormatSource(String numberFormatSource)

The number format source used in the scorecard chart. This field is optional.

Parameters:

numberFormatSource - numberFormatSource or null for none

getScaleFactor

public Double getScaleFactor()

Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.

Returns:

value or null for none

setScaleFactor

public ScorecardChartSpec setScaleFactor(Double scaleFactor)

Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.

Parameters:

scaleFactor - scaleFactor or null for none

set

public ScorecardChartSpec set(String fieldName,
                              Object value)

Overrides:

set in class GenericJson

clone

public ScorecardChartSpec clone()

Overrides:

clone in class GenericJson