View Source GoogleApi.Sheets.V4.Model.ScorecardChartSpec (google_api_sheets v0.34.0)

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.

Attributes

aggregateType (type: String.t, default: nil) - 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.
baselineValueData (type: GoogleApi.Sheets.V4.Model.ChartData.t, default: nil) - The data for scorecard baseline value. This field is optional.
baselineValueFormat (type: GoogleApi.Sheets.V4.Model.BaselineValueFormat.t, default: nil) - Formatting options for baseline value. This field is needed only if baseline_value_data is specified.
customFormatOptions (type: GoogleApi.Sheets.V4.Model.ChartCustomNumberFormatOptions.t, default: nil) - 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.
keyValueData (type: GoogleApi.Sheets.V4.Model.ChartData.t, default: nil) - The data for scorecard key value.
keyValueFormat (type: GoogleApi.Sheets.V4.Model.KeyValueFormat.t, default: nil) - Formatting options for key value.
numberFormatSource (type: String.t, default: nil) - The number format source used in the scorecard chart. This field is optional.
scaleFactor (type: float(), default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Sheets.V4.Model.ScorecardChartSpec{
  aggregateType: String.t() | nil,
  baselineValueData: GoogleApi.Sheets.V4.Model.ChartData.t() | nil,
  baselineValueFormat: GoogleApi.Sheets.V4.Model.BaselineValueFormat.t() | nil,
  customFormatOptions:
    GoogleApi.Sheets.V4.Model.ChartCustomNumberFormatOptions.t() | nil,
  keyValueData: GoogleApi.Sheets.V4.Model.ChartData.t() | nil,
  keyValueFormat: GoogleApi.Sheets.V4.Model.KeyValueFormat.t() | nil,
  numberFormatSource: String.t() | nil,
  scaleFactor: float() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.