Class: Google::Apis::SheetsV4::PivotValue

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

Overview

The definition of how a value in a pivot table should be calculated.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PivotValue

Returns a new instance of PivotValue



6695
6696
6697
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6695

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

Instance Attribute Details

#calculated_display_type ⇒ String

If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values will be displayed as the percentage of the grand total. In the Sheets UI, this is referred to as "Show As" in the value section of a pivot table. Corresponds to the JSON property calculatedDisplayType

Returns:

  • (String) 


6664
6665
6666
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6664

def calculated_display_type
  @calculated_display_type
end

#formula ⇒ String

A custom formula to calculate the value. The formula must start with an = character. Corresponds to the JSON property formula

Returns:

  • (String) 


6670
6671
6672
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6670

def formula
  @formula
end

#name ⇒ String

A name to use for the value. Corresponds to the JSON property name

Returns:

  • (String) 


6675
6676
6677
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6675

def name
  @name
end

#source_column_offset ⇒ Fixnum

The column offset of the source range that this value reads from. For example, if the source was C10:E15, a sourceColumnOffset of 0 means this value refers to column C, whereas the offset 1 would refer to column D. Corresponds to the JSON property sourceColumnOffset

Returns:

  • (Fixnum) 


6683
6684
6685
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6683

def source_column_offset
  @source_column_offset
end

#summarize_function ⇒ String

A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then CUSTOM is not supported. Corresponds to the JSON property summarizeFunction

Returns:

  • (String) 


6693
6694
6695
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6693

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6700
6701
6702
6703
6704
6705
6706
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6700

def update!(**args)
  @calculated_display_type = args[:calculated_display_type] if args.key?(:calculated_display_type)
  @formula = args[:formula] if args.key?(:formula)
  @name = args[:name] if args.key?(:name)
  @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset)
  @summarize_function = args[:summarize_function] if args.key?(:summarize_function)
end