Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

Font and other text style attributes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo.



6454
6455
6456
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6454

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

Instance Attribute Details

#background_color ⇒ Google::Apis::DocumentaiV1::GoogleTypeColor

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

Returns:



6329
6330
6331
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6329

def background_color
  @background_color
end

#bold ⇒ Boolean Also known as: bold?

Whether the text is bold (equivalent to font weight >= 700). Corresponds to the JSON property bold

Returns:

  • (Boolean) 


6334
6335
6336
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6334

def bold
  @bold
end

#font_size ⇒ Fixnum

Font size in points (1 point is 1/72"). Corresponds to the JSON property fontSize

Returns:

  • (Fixnum) 


6340
6341
6342
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6340

def font_size
  @font_size
end

#font_type ⇒ String

Name or style of the font. Corresponds to the JSON property fontType

Returns:

  • (String) 


6345
6346
6347
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6345

def font_type
  @font_type
end

#font_weight ⇒ Fixnum

TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700. Corresponds to the JSON property fontWeight

Returns:

  • (Fixnum) 


6351
6352
6353
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6351

def font_weight
  @font_weight
end

#handwritten ⇒ Boolean Also known as: handwritten?

Whether the text is handwritten. Corresponds to the JSON property handwritten

Returns:

  • (Boolean) 


6356
6357
6358
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6356

def handwritten
  @handwritten
end

#italic ⇒ Boolean Also known as: italic?

Whether the text is italic. Corresponds to the JSON property italic

Returns:

  • (Boolean) 


6362
6363
6364
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6362

def italic
  @italic
end

#letter_spacing ⇒ Float

Letter spacing in points. Corresponds to the JSON property letterSpacing

Returns:

  • (Float) 


6368
6369
6370
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6368

def letter_spacing
  @letter_spacing
end

#pixel_font_size ⇒ Float

Font size in pixels, equal to unrounded_fontsize * resolution / 72.0. Corresponds to the JSON property pixelFontSize

Returns:

  • (Float) 


6373
6374
6375
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6373

def pixel_font_size
  @pixel_font_size
end

#smallcaps ⇒ Boolean Also known as: smallcaps?

Whether the text are small caps. Corresponds to the JSON property smallcaps

Returns:

  • (Boolean) 


6378
6379
6380
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6378

def smallcaps
  @smallcaps
end

#strikeout ⇒ Boolean Also known as: strikeout?

Whether the text is strikethrough. Corresponds to the JSON property strikeout

Returns:

  • (Boolean) 


6384
6385
6386
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6384

def strikeout
  @strikeout
end

#subscript ⇒ Boolean Also known as: subscript?

Whether the text is a subscript. Corresponds to the JSON property subscript

Returns:

  • (Boolean) 


6390
6391
6392
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6390

def subscript
  @subscript
end

#superscript ⇒ Boolean Also known as: superscript?

Whether the text is a superscript. Corresponds to the JSON property superscript

Returns:

  • (Boolean) 


6396
6397
6398
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6396

def superscript
  @superscript
end

#text_color ⇒ Google::Apis::DocumentaiV1::GoogleTypeColor

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 textColor

Returns:



6446
6447
6448
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6446

def text_color
  @text_color
end

#underlined ⇒ Boolean Also known as: underlined?

Whether the text is underlined. Corresponds to the JSON property underlined

Returns:

  • (Boolean) 


6451
6452
6453
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6451

def underlined
  @underlined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6459

def update!(**args)
  @background_color = args[:background_color] if args.key?(:background_color)
  @bold = args[:bold] if args.key?(:bold)
  @font_size = args[:font_size] if args.key?(:font_size)
  @font_type = args[:font_type] if args.key?(:font_type)
  @font_weight = args[:font_weight] if args.key?(:font_weight)
  @handwritten = args[:handwritten] if args.key?(:handwritten)
  @italic = args[:italic] if args.key?(:italic)
  @letter_spacing = args[:letter_spacing] if args.key?(:letter_spacing)
  @pixel_font_size = args[:pixel_font_size] if args.key?(:pixel_font_size)
  @smallcaps = args[:smallcaps] if args.key?(:smallcaps)
  @strikeout = args[:strikeout] if args.key?(:strikeout)
  @subscript = args[:subscript] if args.key?(:subscript)
  @superscript = args[:superscript] if args.key?(:superscript)
  @text_color = args[:text_color] if args.key?(:text_color)
  @underlined = args[:underlined] if args.key?(:underlined)
end