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



1331
1332
1333
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1331

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:



1264
1265
1266
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1264

def axis
  @axis
end

#chart_type ⇒ String

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

Returns:

  • (String) 


1269
1270
1271
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1269

def chart_type
  @chart_type
end

#compare_mode ⇒ String

The behavior of tooltips and data highlighting when hovering on data and chart area. Corresponds to the JSON property compareMode

Returns:

  • (String) 


1275
1276
1277
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1275

def compare_mode
  @compare_mode
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:



1281
1282
1283
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1281

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) 


1290
1291
1292
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1290

def header_count
  @header_count
end

#interpolate_nulls ⇒ Boolean Also known as: interpolate_nulls?

If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. Corresponds to the JSON property interpolateNulls

Returns:

  • (Boolean) 


1298
1299
1300
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1298

def interpolate_nulls
  @interpolate_nulls
end

#legend_position ⇒ String

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

Returns:

  • (String) 


1304
1305
1306
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1304

def legend_position
  @legend_position
end

#line_smoothing ⇒ Boolean Also known as: line_smoothing?

Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. Corresponds to the JSON property lineSmoothing

Returns:

  • (Boolean) 


1310
1311
1312
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1310

def line_smoothing
  @line_smoothing
end

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

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

Returns:



1316
1317
1318
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1316

def series
  @series
end

#stacked_type ⇒ String

The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. Corresponds to the JSON property stackedType

Returns:

  • (String) 


1322
1323
1324
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1322

def stacked_type
  @stacked_type
end

#three_dimensional ⇒ Boolean Also known as: three_dimensional?

True to make the chart 3D. Applies to Bar and Column charts. Corresponds to the JSON property threeDimensional

Returns:

  • (Boolean) 


1328
1329
1330
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1328

def three_dimensional
  @three_dimensional
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1336

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