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.



8560
8561
8562
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8560

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) 


8522
8523
8524
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8522

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:



8527
8528
8529
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8527

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:



8532
8533
8534
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8532

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:



8537
8538
8539
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8537

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:



8542
8543
8544
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8542

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:



8547
8548
8549
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8547

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) 


8552
8553
8554
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8552

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) 


8558
8559
8560
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8558

def scale_factor
  @scale_factor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8565

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