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



5306
5307
5308
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5306

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

Instance Attribute Details

#formula ⇒ String

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

Returns:

  • (String) 


5280
5281
5282
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5280

def formula
  @formula
end

#name ⇒ String

A name to use for the value. This is only used if formula was set. Otherwise, the column name is used. Corresponds to the JSON property name

Returns:

  • (String) 


5286
5287
5288
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5286

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) 


5294
5295
5296
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5294

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) 


5304
5305
5306
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5304

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5311
5312
5313
5314
5315
5316
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5311

def update!(**args)
  @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