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

Constructor Details

#initialize(**args) ⇒ PivotValue

Returns a new instance of PivotValue.



7540
7541
7542
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7540

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) 


7508
7509
7510
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7508

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:



7513
7514
7515
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7513

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) 


7519
7520
7521
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7519

def formula
  @formula
end

#name ⇒ String

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

Returns:

  • (String) 


7524
7525
7526
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7524

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) 


7531
7532
7533
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7531

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) 


7538
7539
7540
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7538

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7545
7546
7547
7548
7549
7550
7551
7552
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7545

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