Class: Google::Apis::SheetsV4::PivotValue
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::PivotValue
- 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
-
#calculated_display_type ⇒ String
If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value.
-
#formula ⇒ String
A custom formula to calculate the value.
-
#name ⇒ String
A name to use for the value.
-
#source_column_offset ⇒ Fixnum
The column offset of the source range that this value reads from.
-
#summarize_function ⇒ String
A function to summarize the value.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PivotValue
constructor
A new instance of PivotValue.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PivotValue
Returns a new instance of PivotValue
6866 6867 6868 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6866 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 are 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
6835 6836 6837 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6835 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
6841 6842 6843 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6841 def formula @formula end |
#name ⇒ String
A name to use for the value.
Corresponds to the JSON property name
6846 6847 6848 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6846 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
6854 6855 6856 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6854 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
6864 6865 6866 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6864 def summarize_function @summarize_function end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6871 6872 6873 6874 6875 6876 6877 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6871 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 |