Class: Google::Apis::SheetsV4::BasicChartSpec
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::BasicChartSpec
- 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
-
#axis ⇒ Array<Google::Apis::SheetsV4::BasicChartAxis>
The axis on the chart.
-
#chart_type ⇒ String
The type of the chart.
-
#compare_mode ⇒ String
The behavior of tooltips and data highlighting when hovering on data and chart area.
-
#domains ⇒ Array<Google::Apis::SheetsV4::BasicChartDomain>
The domain of data this is charting.
-
#header_count ⇒ Fixnum
The number of rows or columns in the data that are "headers".
-
#interpolate_nulls ⇒ Boolean
(also: #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).
-
#legend_position ⇒ String
The position of the chart legend.
-
#line_smoothing ⇒ Boolean
(also: #line_smoothing?)
Gets whether all lines should be rendered smooth or straight by default.
-
#series ⇒ Array<Google::Apis::SheetsV4::BasicChartSeries>
The data this chart is visualizing.
-
#stacked_type ⇒ String
The stacked type for charts that support vertical stacking.
-
#three_dimensional ⇒ Boolean
(also: #three_dimensional?)
True to make the chart 3D.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BasicChartSpec
constructor
A new instance of BasicChartSpec.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BasicChartSpec
Returns a new instance of BasicChartSpec
1358 1359 1360 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1358 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
1291 1292 1293 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1291 def axis @axis end |
#chart_type ⇒ String
The type of the chart.
Corresponds to the JSON property chartType
1296 1297 1298 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1296 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
1302 1303 1304 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1302 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
1308 1309 1310 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1308 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
1317 1318 1319 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1317 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
1325 1326 1327 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1325 def interpolate_nulls @interpolate_nulls end |
#legend_position ⇒ String
The position of the chart legend.
Corresponds to the JSON property legendPosition
1331 1332 1333 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1331 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
1337 1338 1339 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1337 def line_smoothing @line_smoothing end |
#series ⇒ Array<Google::Apis::SheetsV4::BasicChartSeries>
The data this chart is visualizing.
Corresponds to the JSON property series
1343 1344 1345 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1343 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
1349 1350 1351 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1349 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
1355 1356 1357 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1355 def three_dimensional @three_dimensional end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1363 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 |