Class: Google::Apis::SheetsV4::WaterfallChartCustomSubtotal

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

A custom subtotal column for a waterfall chart series.

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) ⇒ WaterfallChartCustomSubtotal

Returns a new instance of WaterfallChartCustomSubtotal



8872
8873
8874
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8872

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

Instance Attribute Details

#data_is_subtotal ⇒ Boolean Also known as: data_is_subtotal?

True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point. Corresponds to the JSON property dataIsSubtotal

Returns:

  • (Boolean) 


8852
8853
8854
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8852

def data_is_subtotal
  @data_is_subtotal
end

#label ⇒ String

A label for the subtotal column. Corresponds to the JSON property label

Returns:

  • (String) 


8858
8859
8860
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8858

def label
  @label
end

#subtotal_index ⇒ Fixnum

The 0-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has 3 data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with. Corresponds to the JSON property subtotalIndex

Returns:

  • (Fixnum) 


8870
8871
8872
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8870

def subtotal_index
  @subtotal_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8877
8878
8879
8880
8881
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8877

def update!(**args)
  @data_is_subtotal = args[:data_is_subtotal] if args.key?(:data_is_subtotal)
  @label = args[:label] if args.key?(:label)
  @subtotal_index = args[:subtotal_index] if args.key?(:subtotal_index)
end