Class: Google::Apis::SheetsV4::SheetProperties

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

Properties of a sheet.

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

Returns a new instance of SheetProperties.


2835
2836
2837
# File 'generated/google/apis/sheets_v4/classes.rb', line 2835

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

Instance Attribute Details

#grid_propertiesGoogle::Apis::SheetsV4::GridProperties

Properties of a grid. Corresponds to the JSON property gridProperties


2712
2713
2714
# File 'generated/google/apis/sheets_v4/classes.rb', line 2712

def grid_properties
  @grid_properties
end

#hiddenBoolean Also known as: hidden?

True if the sheet is hidden in the UI, false if it's visible. Corresponds to the JSON property hidden

Returns:

  • (Boolean)

2706
2707
2708
# File 'generated/google/apis/sheets_v4/classes.rb', line 2706

def hidden
  @hidden
end

#indexFixnum

The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet will be added or moved to the end of the sheet list. Corresponds to the JSON property index

Returns:

  • (Fixnum)

2701
2702
2703
# File 'generated/google/apis/sheets_v4/classes.rb', line 2701

def index
  @index
end

#right_to_leftBoolean Also known as: right_to_left?

True if the sheet is an RTL sheet instead of an LTR sheet. Corresponds to the JSON property rightToLeft

Returns:

  • (Boolean)

2723
2724
2725
# File 'generated/google/apis/sheets_v4/classes.rb', line 2723

def right_to_left
  @right_to_left
end

#sheet_idFixnum

The ID of the sheet. Must be non-negative. This field cannot be changed once set. Corresponds to the JSON property sheetId

Returns:

  • (Fixnum)

2718
2719
2720
# File 'generated/google/apis/sheets_v4/classes.rb', line 2718

def sheet_id
  @sheet_id
end

#sheet_typeString

The type of sheet. Defaults to GRID. This field cannot be changed once set. Corresponds to the JSON property sheetType

Returns:

  • (String)

2833
2834
2835
# File 'generated/google/apis/sheets_v4/classes.rb', line 2833

def sheet_type
  @sheet_type
end

#tab_colorGoogle::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. Here are some examples: 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


2827
2828
2829
# File 'generated/google/apis/sheets_v4/classes.rb', line 2827

def tab_color
  @tab_color
end

#titleString

The name of the sheet. Corresponds to the JSON property title

Returns:

  • (String)

2693
2694
2695
# File 'generated/google/apis/sheets_v4/classes.rb', line 2693

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'generated/google/apis/sheets_v4/classes.rb', line 2840

def update!(**args)
  @title = args[:title] if args.key?(:title)
  @index = args[:index] if args.key?(:index)
  @hidden = args[:hidden] if args.key?(:hidden)
  @grid_properties = args[:grid_properties] if args.key?(:grid_properties)
  @sheet_id = args[:sheet_id] if args.key?(:sheet_id)
  @right_to_left = args[:right_to_left] if args.key?(:right_to_left)
  @tab_color = args[:tab_color] if args.key?(:tab_color)
  @sheet_type = args[:sheet_type] if args.key?(:sheet_type)
end