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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WaterfallChartSeries

Returns a new instance of WaterfallChartSeries.



11379
11380
11381
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11379

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:



11341
11342
11343
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11341

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:



11346
11347
11348
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11346

def data
  @data
end

#data_label ⇒ Google::Apis::SheetsV4::DataLabel

Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph. Corresponds to the JSON property dataLabel

Returns:



11354
11355
11356
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11354

def data_label
  @data_label
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) 


11361
11362
11363
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11361

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:



11367
11368
11369
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11367

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:



11372
11373
11374
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11372

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:



11377
11378
11379
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11377

def subtotal_columns_style
  @subtotal_columns_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11384
11385
11386
11387
11388
11389
11390
11391
11392
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11384

def update!(**args)
  @custom_subtotals = args[:custom_subtotals] if args.key?(:custom_subtotals)
  @data = args[:data] if args.key?(:data)
  @data_label = args[:data_label] if args.key?(:data_label)
  @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