class Google::Apis::SheetsV4::SlicerSpec

The specifications of a slicer.

Attributes

apply_to_pivot_tables[RW]

True if the filter should apply to pivot tables. If not set, default to `True`. Corresponds to the JSON property `applyToPivotTables` @return [Boolean]

apply_to_pivot_tables?[RW]

True if the filter should apply to pivot tables. If not set, default to `True`. Corresponds to the JSON property `applyToPivotTables` @return [Boolean]

background_color[RW]

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. This reference page doesn't 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. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as 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 `backgroundColor` @return [Google::Apis::SheetsV4::Color]

background_color_style[RW]

A color value. Corresponds to the JSON property `backgroundColorStyle` @return [Google::Apis::SheetsV4::ColorStyle]

column_index[RW]

The column index in the data table on which the filter is applied to. Corresponds to the JSON property `columnIndex` @return [Fixnum]

data_range[RW]

A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive – [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `“Sheet1”` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `# REF!`. Corresponds to the JSON property `dataRange` @return [Google::Apis::SheetsV4::GridRange]

filter_criteria[RW]

Criteria for showing/hiding rows in a filter or filter view. Corresponds to the JSON property `filterCriteria` @return [Google::Apis::SheetsV4::FilterCriteria]

horizontal_alignment[RW]

The horizontal alignment of title in the slicer. If unspecified, defaults to ` LEFT` Corresponds to the JSON property `horizontalAlignment` @return [String]

text_format[RW]

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property `textFormat` @return [Google::Apis::SheetsV4::TextFormat]

title[RW]

The title of the slicer. Corresponds to the JSON property `title` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/sheets_v4/classes.rb, line 9041
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/sheets_v4/classes.rb, line 9046
def update!(**args)
  @apply_to_pivot_tables = args[:apply_to_pivot_tables] if args.key?(:apply_to_pivot_tables)
  @background_color = args[:background_color] if args.key?(:background_color)
  @background_color_style = args[:background_color_style] if args.key?(:background_color_style)
  @column_index = args[:column_index] if args.key?(:column_index)
  @data_range = args[:data_range] if args.key?(:data_range)
  @filter_criteria = args[:filter_criteria] if args.key?(:filter_criteria)
  @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment)
  @text_format = args[:text_format] if args.key?(:text_format)
  @title = args[:title] if args.key?(:title)
end