Class: Google::Apis::SheetsV4::PivotFilterCriteria

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

Criteria for showing/hiding rows in a pivot table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PivotFilterCriteria

Returns a new instance of PivotFilterCriteria.



7101
7102
7103
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7101

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

Instance Attribute Details

#condition ⇒ Google::Apis::SheetsV4::BooleanCondition

A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters. Corresponds to the JSON property condition

Returns:



7086
7087
7088
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7086

def condition
  @condition
end

#visible_by_default ⇒ Boolean Also known as: visible_by_default?

Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown. Corresponds to the JSON property visibleByDefault

Returns:

  • (Boolean) 


7093
7094
7095
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7093

def visible_by_default
  @visible_by_default
end

#visible_values ⇒ Array<String>

Values that should be included. Values not listed here are excluded. Corresponds to the JSON property visibleValues

Returns:

  • (Array<String>) 


7099
7100
7101
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7099

def visible_values
  @visible_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7106
7107
7108
7109
7110
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7106

def update!(**args)
  @condition = args[:condition] if args.key?(:condition)
  @visible_by_default = args[:visible_by_default] if args.key?(:visible_by_default)
  @visible_values = args[:visible_values] if args.key?(:visible_values)
end