Class: Google::Apis::SheetsV4::WaterfallChartSeries

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 single series of data for a waterfall chart.

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

Returns a new instance of WaterfallChartSeries



8949
8950
8951
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8949

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

Instance Attribute Details

#custom_subtotals ⇒ Array<Google::Apis::SheetsV4::WaterfallChartCustomSubtotal>

Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point. Corresponds to the JSON property customSubtotals

Returns:



8919
8920
8921
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8919

def custom_subtotals
  @custom_subtotals
end

#data ⇒ Google::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property data

Returns:



8924
8925
8926
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8924

def data
  @data
end

#hide_trailing_subtotal ⇒ Boolean Also known as: hide_trailing_subtotal?

True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series. Corresponds to the JSON property hideTrailingSubtotal

Returns:

  • (Boolean) 


8931
8932
8933
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8931

def hide_trailing_subtotal
  @hide_trailing_subtotal
end

#negative_columns_style ⇒ Google::Apis::SheetsV4::WaterfallChartColumnStyle

Styles for a waterfall chart column. Corresponds to the JSON property negativeColumnsStyle

Returns:



8937
8938
8939
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8937

def negative_columns_style
  @negative_columns_style
end

#positive_columns_style ⇒ Google::Apis::SheetsV4::WaterfallChartColumnStyle

Styles for a waterfall chart column. Corresponds to the JSON property positiveColumnsStyle

Returns:



8942
8943
8944
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8942

def positive_columns_style
  @positive_columns_style
end

#subtotal_columns_style ⇒ Google::Apis::SheetsV4::WaterfallChartColumnStyle

Styles for a waterfall chart column. Corresponds to the JSON property subtotalColumnsStyle

Returns:



8947
8948
8949
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8947

def subtotal_columns_style
  @subtotal_columns_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8954
8955
8956
8957
8958
8959
8960
8961
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8954

def update!(**args)
  @custom_subtotals = args[:custom_subtotals] if args.key?(:custom_subtotals)
  @data = args[:data] if args.key?(:data)
  @hide_trailing_subtotal = args[:hide_trailing_subtotal] if args.key?(:hide_trailing_subtotal)
  @negative_columns_style = args[:negative_columns_style] if args.key?(:negative_columns_style)
  @positive_columns_style = args[:positive_columns_style] if args.key?(:positive_columns_style)
  @subtotal_columns_style = args[:subtotal_columns_style] if args.key?(:subtotal_columns_style)
end