Class: Google::Apis::SheetsV4::FilterCriteria

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

Criteria for showing/hiding rows in a filter or filter view.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FilterCriteria

Returns a new instance of FilterCriteria.



5536
5537
5538
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5536

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:



5421
5422
5423
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5421

def condition
  @condition
end

#hidden_values ⇒ Array<String>

Values that should be hidden. Corresponds to the JSON property hiddenValues

Returns:

  • (Array<String>) 


5426
5427
5428
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5426

def hidden_values
  @hidden_values
end

#visible_background_color ⇒ Google::Apis::SheetsV4::Color

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( ), alpha); public static Color toProto(java.awt.Color color) float red = ( float) color.getRed(); float green = (float) color.getGreen(); float blue = ( float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); return resultBuilder.build(); // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) float red = [ protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( alpha_wrapper != nil) alpha = [alpha_wrapper value]; return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; static Color* toProto( UIColor* color) CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) return nil; Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: blue]; if (alpha <= 0.9999) [result setAlpha:floatWrapperWithValue(alpha)]; [result autorelease]; return result; // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) return rgbToCssColor_(red, green, blue); var alphaFrac = rgb_color.alpha.value || 0. 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', ', alphaFrac, ')'].join('');; var rgbToCssColor_ = function(red, green, blue) var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) resultBuilder.push('0'); resultBuilder.push(hexString); return resultBuilder. join('');; // ... Corresponds to the JSON property visibleBackgroundColor

Returns:



5475
5476
5477
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5475

def visible_background_color
  @visible_background_color
end

#visible_background_color_style ⇒ Google::Apis::SheetsV4::ColorStyle

A color value. Corresponds to the JSON property visibleBackgroundColorStyle

Returns:



5480
5481
5482
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5480

def visible_background_color_style
  @visible_background_color_style
end

#visible_foreground_color ⇒ Google::Apis::SheetsV4::Color

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( ), alpha); public static Color toProto(java.awt.Color color) float red = ( float) color.getRed(); float green = (float) color.getGreen(); float blue = ( float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); return resultBuilder.build(); // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) float red = [ protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( alpha_wrapper != nil) alpha = [alpha_wrapper value]; return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; static Color* toProto( UIColor* color) CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) return nil; Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: blue]; if (alpha <= 0.9999) [result setAlpha:floatWrapperWithValue(alpha)]; [result autorelease]; return result; // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) return rgbToCssColor_(red, green, blue); var alphaFrac = rgb_color.alpha.value || 0. 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', ', alphaFrac, ')'].join('');; var rgbToCssColor_ = function(red, green, blue) var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) resultBuilder.push('0'); resultBuilder.push(hexString); return resultBuilder. join('');; // ... Corresponds to the JSON property visibleForegroundColor

Returns:



5529
5530
5531
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5529

def visible_foreground_color
  @visible_foreground_color
end

#visible_foreground_color_style ⇒ Google::Apis::SheetsV4::ColorStyle

A color value. Corresponds to the JSON property visibleForegroundColorStyle

Returns:



5534
5535
5536
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5534

def visible_foreground_color_style
  @visible_foreground_color_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5541
5542
5543
5544
5545
5546
5547
5548
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5541

def update!(**args)
  @condition = args[:condition] if args.key?(:condition)
  @hidden_values = args[:hidden_values] if args.key?(:hidden_values)
  @visible_background_color = args[:visible_background_color] if args.key?(:visible_background_color)
  @visible_background_color_style = args[:visible_background_color_style] if args.key?(:visible_background_color_style)
  @visible_foreground_color = args[:visible_foreground_color] if args.key?(:visible_foreground_color)
  @visible_foreground_color_style = args[:visible_foreground_color_style] if args.key?(:visible_foreground_color_style)
end