Class: Google::Apis::SheetsV4::BasicChartSpec

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

The specification for a basic chart. See BasicChartType for the list of charts this supports.

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

Returns a new instance of BasicChartSpec



815
816
817
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 815

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

Instance Attribute Details

#axis ⇒ Array<Google::Apis::SheetsV4::BasicChartAxis>

The axis on the chart. Corresponds to the JSON property axis

Returns:



813
814
815
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 813

def axis
  @axis
end

#chart_type ⇒ String

The type of the chart. Corresponds to the JSON property chartType

Returns:

  • (String) 


783
784
785
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 783

def chart_type
  @chart_type
end

#domains ⇒ Array<Google::Apis::SheetsV4::BasicChartDomain>

The domain of data this is charting. Only a single domain is supported. Corresponds to the JSON property domains

Returns:



799
800
801
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 799

def domains
  @domains
end

#header_count ⇒ Fixnum

The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) Corresponds to the JSON property headerCount

Returns:

  • (Fixnum) 


808
809
810
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 808

def header_count
  @header_count
end

#legend_position ⇒ String

The position of the chart legend. Corresponds to the JSON property legendPosition

Returns:

  • (String) 


793
794
795
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 793

def legend_position
  @legend_position
end

#series ⇒ Array<Google::Apis::SheetsV4::BasicChartSeries>

The data this chart is visualizing. Corresponds to the JSON property series

Returns:



788
789
790
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 788

def series
  @series
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



820
821
822
823
824
825
826
827
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 820

def update!(**args)
  @chart_type = args[:chart_type] if args.key?(:chart_type)
  @series = args[:series] if args.key?(:series)
  @legend_position = args[:legend_position] if args.key?(:legend_position)
  @domains = args[:domains] if args.key?(:domains)
  @header_count = args[:header_count] if args.key?(:header_count)
  @axis = args[:axis] if args.key?(:axis)
end