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

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PivotValue

Returns a new instance of PivotValue.



7647
7648
7649
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7647

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 are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot table. Corresponds to the JSON property calculatedDisplayType

Returns:

  • (String) 


7615
7616
7617
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7615

def calculated_display_type
  @calculated_display_type
end

#data_source_column_reference ⇒ Google::Apis::SheetsV4::DataSourceColumnReference

An unique identifier that references a data source column. Corresponds to the JSON property dataSourceColumnReference

Returns:



7620
7621
7622
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7620

def data_source_column_reference
  @data_source_column_reference
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) 


7626
7627
7628
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7626

def formula
  @formula
end

#name ⇒ String

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

Returns:

  • (String) 


7631
7632
7633
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7631

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) 


7638
7639
7640
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7638

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) 


7645
7646
7647
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7645

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7652
7653
7654
7655
7656
7657
7658
7659
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7652

def update!(**args)
  @calculated_display_type = args[:calculated_display_type] if args.key?(:calculated_display_type)
  @data_source_column_reference = args[:data_source_column_reference] if args.key?(:data_source_column_reference)
  @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