class Google::Apis::SheetsV4::SheetProperties

Properties of a sheet.

Attributes

data_source_sheet_properties[RW]

Additional properties of a DATA_SOURCE sheet. Corresponds to the JSON property `dataSourceSheetProperties` @return [Google::Apis::SheetsV4::DataSourceSheetProperties]

grid_properties[RW]

Properties of a grid. Corresponds to the JSON property `gridProperties` @return [Google::Apis::SheetsV4::GridProperties]

hidden[RW]

True if the sheet is hidden in the UI, false if it's visible. Corresponds to the JSON property `hidden` @return [Boolean]

hidden?[RW]

True if the sheet is hidden in the UI, false if it's visible. Corresponds to the JSON property `hidden` @return [Boolean]

index[RW]

The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in “before the move” indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1. Corresponds to the JSON property `index` @return [Fixnum]

right_to_left[RW]

True if the sheet is an RTL sheet instead of an LTR sheet. Corresponds to the JSON property `rightToLeft` @return [Boolean]

right_to_left?[RW]

True if the sheet is an RTL sheet instead of an LTR sheet. Corresponds to the JSON property `rightToLeft` @return [Boolean]

sheet_id[RW]

The ID of the sheet. Must be non-negative. This field cannot be changed once set. Corresponds to the JSON property `sheetId` @return [Fixnum]

sheet_type[RW]

The type of sheet. Defaults to GRID. This field cannot be changed once set. Corresponds to the JSON property `sheetType` @return [String]

tab_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 `tabColor` @return [Google::Apis::SheetsV4::Color]

tab_color_style[RW]

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

title[RW]

The name of the sheet. 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 8883
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 8888
def update!(**args)
  @data_source_sheet_properties = args[:data_source_sheet_properties] if args.key?(:data_source_sheet_properties)
  @grid_properties = args[:grid_properties] if args.key?(:grid_properties)
  @hidden = args[:hidden] if args.key?(:hidden)
  @index = args[:index] if args.key?(:index)
  @right_to_left = args[:right_to_left] if args.key?(:right_to_left)
  @sheet_id = args[:sheet_id] if args.key?(:sheet_id)
  @sheet_type = args[:sheet_type] if args.key?(:sheet_type)
  @tab_color = args[:tab_color] if args.key?(:tab_color)
  @tab_color_style = args[:tab_color_style] if args.key?(:tab_color_style)
  @title = args[:title] if args.key?(:title)
end