class Google::Apis::SheetsV4::PivotValue

The definition of how a value in a pivot table should be calculated.

Attributes

calculated_display_type[RW]

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` @return [String]

data_source_column_reference[RW]

An unique identifier that references a data source column. Corresponds to the JSON property `dataSourceColumnReference` @return [Google::Apis::SheetsV4::DataSourceColumnReference]

formula[RW]

A custom formula to calculate the value. The formula must start with an `=` character. Corresponds to the JSON property `formula` @return [String]

name[RW]

A name to use for the value. Corresponds to the JSON property `name` @return [String]

source_column_offset[RW]

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` @return [Fixnum]

summarize_function[RW]

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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/sheets_v4/classes.rb, line 7561
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/sheets_v4/classes.rb, line 7566
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