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.



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

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

Instance Attribute Details

#axisArray<Google::Apis::SheetsV4::BasicChartAxis>

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



1235
1236
1237
# File 'generated/google/apis/sheets_v4/classes.rb', line 1235

def axis
  @axis
end

#chart_typeString

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

Returns:

  • (String)


1240
1241
1242
# File 'generated/google/apis/sheets_v4/classes.rb', line 1240

def chart_type
  @chart_type
end

#compare_modeString

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

Returns:

  • (String)


1246
1247
1248
# File 'generated/google/apis/sheets_v4/classes.rb', line 1246

def compare_mode
  @compare_mode
end

#domainsArray<Google::Apis::SheetsV4::BasicChartDomain>

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



1251
1252
1253
# File 'generated/google/apis/sheets_v4/classes.rb', line 1251

def domains
  @domains
end

#header_countFixnum

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)


1259
1260
1261
# File 'generated/google/apis/sheets_v4/classes.rb', line 1259

def header_count
  @header_count
end

#interpolate_nullsBoolean 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)


1266
1267
1268
# File 'generated/google/apis/sheets_v4/classes.rb', line 1266

def interpolate_nulls
  @interpolate_nulls
end

#legend_positionString

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

Returns:

  • (String)


1272
1273
1274
# File 'generated/google/apis/sheets_v4/classes.rb', line 1272

def legend_position
  @legend_position
end

#line_smoothingBoolean 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)


1278
1279
1280
# File 'generated/google/apis/sheets_v4/classes.rb', line 1278

def line_smoothing
  @line_smoothing
end

#seriesArray<Google::Apis::SheetsV4::BasicChartSeries>

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



1284
1285
1286
# File 'generated/google/apis/sheets_v4/classes.rb', line 1284

def series
  @series
end

#stacked_typeString

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)


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

def stacked_type
  @stacked_type
end

#three_dimensionalBoolean 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)


1295
1296
1297
# File 'generated/google/apis/sheets_v4/classes.rb', line 1295

def three_dimensional
  @three_dimensional
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
# File 'generated/google/apis/sheets_v4/classes.rb', line 1303

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