Class: Google::Apis::SheetsV4::CellFormat

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

The format of a cell.

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

Returns a new instance of CellFormat.



3041
3042
3043
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3041

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

Instance Attribute Details

#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. 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

Returns:



2982
2983
2984
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2982

def background_color
  @background_color
end

#background_color_style ⇒ Google::Apis::SheetsV4::ColorStyle

A color value. Corresponds to the JSON property backgroundColorStyle

Returns:



2987
2988
2989
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2987

def background_color_style
  @background_color_style
end

#borders ⇒ Google::Apis::SheetsV4::Borders

The borders of the cell. Corresponds to the JSON property borders

Returns:



2992
2993
2994
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2992

def borders
  @borders
end

#horizontal_alignment ⇒ String

The horizontal alignment of the value in the cell. Corresponds to the JSON property horizontalAlignment

Returns:

  • (String) 


2997
2998
2999
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2997

def horizontal_alignment
  @horizontal_alignment
end

#hyperlink_display_type ⇒ String

How a hyperlink, if it exists, should be displayed in the cell. Corresponds to the JSON property hyperlinkDisplayType

Returns:

  • (String) 


3002
3003
3004
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3002

def hyperlink_display_type
  @hyperlink_display_type
end

#number_format ⇒ Google::Apis::SheetsV4::NumberFormat

The number format of a cell. Corresponds to the JSON property numberFormat

Returns:



3007
3008
3009
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3007

def number_format
  @number_format
end

#padding ⇒ Google::Apis::SheetsV4::Padding

The amount of padding around the cell, in pixels. When updating padding, every field must be specified. Corresponds to the JSON property padding

Returns:



3013
3014
3015
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3013

def padding
  @padding
end

#text_direction ⇒ String

The direction of the text in the cell. Corresponds to the JSON property textDirection

Returns:

  • (String) 


3018
3019
3020
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3018

def text_direction
  @text_direction
end

#text_format ⇒ Google::Apis::SheetsV4::TextFormat

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

Returns:



3024
3025
3026
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3024

def text_format
  @text_format
end

#text_rotation ⇒ Google::Apis::SheetsV4::TextRotation

The rotation applied to text in a cell. Corresponds to the JSON property textRotation

Returns:



3029
3030
3031
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3029

def text_rotation
  @text_rotation
end

#vertical_alignment ⇒ String

The vertical alignment of the value in the cell. Corresponds to the JSON property verticalAlignment

Returns:

  • (String) 


3034
3035
3036
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3034

def vertical_alignment
  @vertical_alignment
end

#wrap_strategy ⇒ String

The wrap strategy for the value in the cell. Corresponds to the JSON property wrapStrategy

Returns:

  • (String) 


3039
3040
3041
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3039

def wrap_strategy
  @wrap_strategy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3046

def update!(**args)
  @background_color = args[:background_color] if args.key?(:background_color)
  @background_color_style = args[:background_color_style] if args.key?(:background_color_style)
  @borders = args[:borders] if args.key?(:borders)
  @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment)
  @hyperlink_display_type = args[:hyperlink_display_type] if args.key?(:hyperlink_display_type)
  @number_format = args[:number_format] if args.key?(:number_format)
  @padding = args[:padding] if args.key?(:padding)
  @text_direction = args[:text_direction] if args.key?(:text_direction)
  @text_format = args[:text_format] if args.key?(:text_format)
  @text_rotation = args[:text_rotation] if args.key?(:text_rotation)
  @vertical_alignment = args[:vertical_alignment] if args.key?(:vertical_alignment)
  @wrap_strategy = args[:wrap_strategy] if args.key?(:wrap_strategy)
end