Represents a Style.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1beta3.Document.IStyle);Constructs a new Style.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStyle
Properties to set |
Properties
backgroundColor
public backgroundColor?: (google.type.IColor|null);Style backgroundColor.
color
public color?: (google.type.IColor|null);Style color.
fontFamily
public fontFamily: string;Style fontFamily.
fontSize
public fontSize?: (google.cloud.documentai.v1beta3.Document.Style.IFontSize|null);Style fontSize.
fontWeight
public fontWeight: string;Style fontWeight.
textAnchor
public textAnchor?: (google.cloud.documentai.v1beta3.Document.ITextAnchor|null);Style textAnchor.
textDecoration
public textDecoration: string;Style textDecoration.
textStyle
public textStyle: string;Style textStyle.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1beta3.Document.IStyle): google.cloud.documentai.v1beta3.Document.Style;Creates a new Style instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStyle
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Style | Style instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Document.Style;Decodes a Style message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Style | Style |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Document.Style;Decodes a Style message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Style | Style |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1beta3.Document.IStyle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Style message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStyle
Style message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.documentai.v1beta3.Document.IStyle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Style message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStyle
Style message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1beta3.Document.Style;Creates a Style message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Style | Style |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Style
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Style to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1beta3.Document.Style, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Style message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Style
Style |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Style message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|