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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/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.



11351
11352
11353
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11351

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) 


11332
11333
11334
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11332

def data_is_subtotal
  @data_is_subtotal
end

#label ⇒ String

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

Returns:

  • (String) 


11338
11339
11340
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11338

def label
  @label
end

#subtotal_index ⇒ Fixnum

The zero-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) 


11349
11350
11351
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11349

def subtotal_index
  @subtotal_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11356
11357
11358
11359
11360
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11356

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