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.



7227
7228
7229
# File 'generated/google/apis/sheets_v4/classes.rb', line 7227

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

Instance Attribute Details

#calculated_display_typeString

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)


7195
7196
7197
# File 'generated/google/apis/sheets_v4/classes.rb', line 7195

def calculated_display_type
  @calculated_display_type
end

#data_source_column_referenceGoogle::Apis::SheetsV4::DataSourceColumnReference

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



7200
7201
7202
# File 'generated/google/apis/sheets_v4/classes.rb', line 7200

def data_source_column_reference
  @data_source_column_reference
end

#formulaString

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

Returns:

  • (String)


7206
7207
7208
# File 'generated/google/apis/sheets_v4/classes.rb', line 7206

def formula
  @formula
end

#nameString

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

Returns:

  • (String)


7211
7212
7213
# File 'generated/google/apis/sheets_v4/classes.rb', line 7211

def name
  @name
end

#source_column_offsetFixnum

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)


7218
7219
7220
# File 'generated/google/apis/sheets_v4/classes.rb', line 7218

def source_column_offset
  @source_column_offset
end

#summarize_functionString

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)


7225
7226
7227
# File 'generated/google/apis/sheets_v4/classes.rb', line 7225

def summarize_function
  @summarize_function
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7232
7233
7234
7235
7236
7237
7238
7239
# File 'generated/google/apis/sheets_v4/classes.rb', line 7232

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