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



6356
6357
6358
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6356

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) 


6325
6326
6327
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6325

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) 


6331
6332
6333
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6331

def formula
  @formula
end

#name ⇒ String

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

Returns:

  • (String) 


6336
6337
6338
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6336

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) 


6344
6345
6346
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6344

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) 


6354
6355
6356
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6354

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6361
6362
6363
6364
6365
6366
6367
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6361

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