Class: Google::Apis::SheetsV4::HistogramChartSpec

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

A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.

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

Returns a new instance of HistogramChartSpec



4766
4767
4768
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4766

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

Instance Attribute Details

#bucket_size ⇒ Float

By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional. Corresponds to the JSON property bucketSize

Returns:

  • (Float) 


4735
4736
4737
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4735

def bucket_size
  @bucket_size
end

#legend_position ⇒ String

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

Returns:

  • (String) 


4740
4741
4742
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4740

def legend_position
  @legend_position
end

#outlier_percentile ⇒ Float

The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5. Corresponds to the JSON property outlierPercentile

Returns:

  • (Float) 


4750
4751
4752
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4750

def outlier_percentile
  @outlier_percentile
end

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

The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series. Corresponds to the JSON property series

Returns:



4757
4758
4759
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4757

def series
  @series
end

#show_item_dividers ⇒ Boolean Also known as: show_item_dividers?

Whether horizontal divider lines should be displayed between items in each column. Corresponds to the JSON property showItemDividers

Returns:

  • (Boolean) 


4763
4764
4765
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4763

def show_item_dividers
  @show_item_dividers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4771
4772
4773
4774
4775
4776
4777
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4771

def update!(**args)
  @bucket_size = args[:bucket_size] if args.key?(:bucket_size)
  @legend_position = args[:legend_position] if args.key?(:legend_position)
  @outlier_percentile = args[:outlier_percentile] if args.key?(:outlier_percentile)
  @series = args[:series] if args.key?(:series)
  @show_item_dividers = args[:show_item_dividers] if args.key?(:show_item_dividers)
end