Class: Google::Apis::SheetsV4::HistogramRule

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

Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end will be placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start will be placed in one group, and all values above HistogramRule.end will be placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+

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

Returns a new instance of HistogramRule



4853
4854
4855
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4853

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

Instance Attribute Details

#end ⇒ Float

The maximum value at which items will be placed into buckets of constant size. Values above end will be lumped into a single bucket. This field is optional. Corresponds to the JSON property end

Returns:

  • (Float) 


4839
4840
4841
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4839

def end
  @end
end

#interval ⇒ Float

The size of the buckets that will be created. Must be positive. Corresponds to the JSON property interval

Returns:

  • (Float) 


4844
4845
4846
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4844

def interval
  @interval
end

#start ⇒ Float

The minimum value at which items will be placed into buckets of constant size. Values below start will be lumped into a single bucket. This field is optional. Corresponds to the JSON property start

Returns:

  • (Float) 


4851
4852
4853
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4851

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4858
4859
4860
4861
4862
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4858

def update!(**args)
  @end = args[:end] if args.key?(:end)
  @interval = args[:interval] if args.key?(:interval)
  @start = args[:start] if args.key?(:start)
end