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

Constructor Details

#initialize(**args) ⇒ WaterfallChartCustomSubtotal

Returns a new instance of WaterfallChartCustomSubtotal.



11131
11132
11133
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 11131

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) 


11112
11113
11114
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 11112

def data_is_subtotal
  @data_is_subtotal
end

#label ⇒ String

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

Returns:

  • (String) 


11118
11119
11120
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 11118

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 three 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) 


11129
11130
11131
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 11129

def subtotal_index
  @subtotal_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11136
11137
11138
11139
11140
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 11136

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