Class: Google::Apis::SheetsV4::TextFormat

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 run of text in a cell. Absent values indicate that the field isn't specified.

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

Returns a new instance of TextFormat.


429
430
431
# File 'generated/google/apis/sheets_v4/classes.rb', line 429

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

Instance Attribute Details

#boldBoolean Also known as: bold?

True if the text is bold. Corresponds to the JSON property bold

Returns:

  • (Boolean)

295
296
297
# File 'generated/google/apis/sheets_v4/classes.rb', line 295

def bold
  @bold
end

#font_familyString

The font family. Corresponds to the JSON property fontFamily

Returns:

  • (String)

410
411
412
# File 'generated/google/apis/sheets_v4/classes.rb', line 410

def font_family
  @font_family
end

#font_sizeFixnum

The size of the font. Corresponds to the JSON property fontSize

Returns:

  • (Fixnum)

421
422
423
# File 'generated/google/apis/sheets_v4/classes.rb', line 421

def font_size
  @font_size
end

#foreground_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 foregroundColor


405
406
407
# File 'generated/google/apis/sheets_v4/classes.rb', line 405

def foreground_color
  @foreground_color
end

#italicBoolean Also known as: italic?

True if the text is italicized. Corresponds to the JSON property italic

Returns:

  • (Boolean)

301
302
303
# File 'generated/google/apis/sheets_v4/classes.rb', line 301

def italic
  @italic
end

#strikethroughBoolean Also known as: strikethrough?

True if the text has a strikethrough. Corresponds to the JSON property strikethrough

Returns:

  • (Boolean)

415
416
417
# File 'generated/google/apis/sheets_v4/classes.rb', line 415

def strikethrough
  @strikethrough
end

#underlineBoolean Also known as: underline?

True if the text is underlined. Corresponds to the JSON property underline

Returns:

  • (Boolean)

426
427
428
# File 'generated/google/apis/sheets_v4/classes.rb', line 426

def underline
  @underline
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


434
435
436
437
438
439
440
441
442
# File 'generated/google/apis/sheets_v4/classes.rb', line 434

def update!(**args)
  @bold = args[:bold] if args.key?(:bold)
  @italic = args[:italic] if args.key?(:italic)
  @foreground_color = args[:foreground_color] if args.key?(:foreground_color)
  @font_family = args[:font_family] if args.key?(:font_family)
  @strikethrough = args[:strikethrough] if args.key?(:strikethrough)
  @font_size = args[:font_size] if args.key?(:font_size)
  @underline = args[:underline] if args.key?(:underline)
end