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



6003
6004
6005
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6003

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) 


5977
5978
5979
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5977

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) 


5983
5984
5985
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5983

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) 


5991
5992
5993
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5991

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) 


6001
6002
6003
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6001

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6008
6009
6010
6011
6012
6013
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6008

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