Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo
- Inherits:
-
Object
- Object
- Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo
- 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 more...
Overview
Font and other text style attributes.
Instance Attribute Summary collapse
-
#background_color ⇒ Google::Apis::DocumentaiV1::GoogleTypeColor
Represents a color in the RGBA color space.
-
#bold ⇒ Boolean
(also: #bold?)
Whether the text is bold (equivalent to font_weight is at least
700
). -
#font_size ⇒ Fixnum
Font size in points (
1
point is¹⁄₇₂
inches). -
#font_type ⇒ String
Name or style of the font.
-
#font_weight ⇒ Fixnum
TrueType weight on a scale
100
(thin) to1000
(ultra-heavy). -
#handwritten ⇒ Boolean
(also: #handwritten?)
Whether the text is handwritten.
-
#italic ⇒ Boolean
(also: #italic?)
Whether the text is italic.
-
#letter_spacing ⇒ Float
Letter spacing in points.
-
#pixel_font_size ⇒ Float
Font size in pixels, equal to unrounded font_size * resolution ÷
72.0
. -
#smallcaps ⇒ Boolean
(also: #smallcaps?)
Whether the text is in small caps.
-
#strikeout ⇒ Boolean
(also: #strikeout?)
Whether the text is strikethrough.
-
#subscript ⇒ Boolean
(also: #subscript?)
Whether the text is a subscript.
-
#superscript ⇒ Boolean
(also: #superscript?)
Whether the text is a superscript.
-
#text_color ⇒ Google::Apis::DocumentaiV1::GoogleTypeColor
Represents a color in the RGBA color space.
-
#underlined ⇒ Boolean
(also: #underlined?)
Whether the text is underlined.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo
constructor
A new instance of GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo
Returns a new instance of GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo.
3193 3194 3195 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3193 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 and 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 have
information about the absolute color space that should be used to interpret
the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. 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
3068 3069 3070 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3068 def background_color @background_color end |
#bold ⇒ Boolean Also known as: bold?
Whether the text is bold (equivalent to font_weight is at least 700
).
Corresponds to the JSON property bold
3073 3074 3075 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3073 def bold @bold end |
#font_size ⇒ Fixnum
Font size in points (1
point is ¹⁄₇₂
inches).
Corresponds to the JSON property fontSize
3079 3080 3081 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3079 def font_size @font_size end |
#font_type ⇒ String
Name or style of the font.
Corresponds to the JSON property fontType
3084 3085 3086 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3084 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
3090 3091 3092 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3090 def font_weight @font_weight end |
#handwritten ⇒ Boolean Also known as: handwritten?
Whether the text is handwritten.
Corresponds to the JSON property handwritten
3095 3096 3097 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3095 def handwritten @handwritten end |
#italic ⇒ Boolean Also known as: italic?
Whether the text is italic.
Corresponds to the JSON property italic
3101 3102 3103 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3101 def italic @italic end |
#letter_spacing ⇒ Float
Letter spacing in points.
Corresponds to the JSON property letterSpacing
3107 3108 3109 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3107 def letter_spacing @letter_spacing end |
#pixel_font_size ⇒ Float
Font size in pixels, equal to unrounded font_size * resolution ÷ 72.0
.
Corresponds to the JSON property pixelFontSize
3112 3113 3114 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3112 def pixel_font_size @pixel_font_size end |
#smallcaps ⇒ Boolean Also known as: smallcaps?
Whether the text is in small caps.
Corresponds to the JSON property smallcaps
3117 3118 3119 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3117 def smallcaps @smallcaps end |
#strikeout ⇒ Boolean Also known as: strikeout?
Whether the text is strikethrough.
Corresponds to the JSON property strikeout
3123 3124 3125 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3123 def strikeout @strikeout end |
#subscript ⇒ Boolean Also known as: subscript?
Whether the text is a subscript.
Corresponds to the JSON property subscript
3129 3130 3131 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3129 def subscript @subscript end |
#superscript ⇒ Boolean Also known as: superscript?
Whether the text is a superscript.
Corresponds to the JSON property superscript
3135 3136 3137 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3135 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 and 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 have
information about the absolute color space that should be used to interpret
the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. 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
3185 3186 3187 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3185 def text_color @text_color end |
#underlined ⇒ Boolean Also known as: underlined?
Whether the text is underlined.
Corresponds to the JSON property underlined
3190 3191 3192 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3190 def underlined @underlined end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 3198 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 |