Class: Google::Apis::SheetsV4::ScorecardChartSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScorecardChartSpec

Returns a new instance of ScorecardChartSpec.



8728
8729
8730
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8728

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregate_type ⇒ String

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. Corresponds to the JSON property aggregateType

Returns:

  • (String) 


8690
8691
8692
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8690

def aggregate_type
  @aggregate_type
end

#baseline_value_data ⇒ Google::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property baselineValueData

Returns:



8695
8696
8697
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8695

def baseline_value_data
  @baseline_value_data
end

#baseline_value_format ⇒ Google::Apis::SheetsV4::BaselineValueFormat

Formatting options for baseline value. Corresponds to the JSON property baselineValueFormat

Returns:



8700
8701
8702
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8700

def baseline_value_format
  @baseline_value_format
end

#custom_format_options ⇒ Google::Apis::SheetsV4::ChartCustomNumberFormatOptions

Custom number formatting options for chart attributes. Corresponds to the JSON property customFormatOptions

Returns:



8705
8706
8707
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8705

def custom_format_options
  @custom_format_options
end

#key_value_data ⇒ Google::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property keyValueData

Returns:



8710
8711
8712
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8710

def key_value_data
  @key_value_data
end

#key_value_format ⇒ Google::Apis::SheetsV4::KeyValueFormat

Formatting options for key value. Corresponds to the JSON property keyValueFormat

Returns:



8715
8716
8717
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8715

def key_value_format
  @key_value_format
end

#number_format_source ⇒ String

The number format source used in the scorecard chart. This field is optional. Corresponds to the JSON property numberFormatSource

Returns:

  • (String) 


8720
8721
8722
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8720

def number_format_source
  @number_format_source
end

#scale_factor ⇒ Float

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. Corresponds to the JSON property scaleFactor

Returns:

  • (Float) 


8726
8727
8728
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8726

def scale_factor
  @scale_factor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8733

def update!(**args)
  @aggregate_type = args[:aggregate_type] if args.key?(:aggregate_type)
  @baseline_value_data = args[:baseline_value_data] if args.key?(:baseline_value_data)
  @baseline_value_format = args[:baseline_value_format] if args.key?(:baseline_value_format)
  @custom_format_options = args[:custom_format_options] if args.key?(:custom_format_options)
  @key_value_data = args[:key_value_data] if args.key?(:key_value_data)
  @key_value_format = args[:key_value_format] if args.key?(:key_value_format)
  @number_format_source = args[:number_format_source] if args.key?(:number_format_source)
  @scale_factor = args[:scale_factor] if args.key?(:scale_factor)
end