Class protos.google.cloud.documentai.v1beta2.Document.Style (3.0.2)

Represents a Style.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta2.Document.IStyle);

Constructs a new Style.

Parameter
NameDescription
properties IStyle

Properties to set

Properties

backgroundColor

public backgroundColor?: (google.type.IColor|null);

Style backgroundColor.

Property Value
TypeDescription
(google.type.IColor|null)

color

public color?: (google.type.IColor|null);

Style color.

Property Value
TypeDescription
(google.type.IColor|null)

fontSize

public fontSize?: (google.cloud.documentai.v1beta2.Document.Style.IFontSize|null);

Style fontSize.

Property Value
TypeDescription
(google.cloud.documentai.v1beta2.Document.Style.IFontSize|null)

fontWeight

public fontWeight: string;

Style fontWeight.

Property Value
TypeDescription
string

textAnchor

public textAnchor?: (google.cloud.documentai.v1beta2.Document.ITextAnchor|null);

Style textAnchor.

Property Value
TypeDescription
(google.cloud.documentai.v1beta2.Document.ITextAnchor|null)

textDecoration

public textDecoration: string;

Style textDecoration.

Property Value
TypeDescription
string

textStyle

public textStyle: string;

Style textStyle.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta2.Document.IStyle): google.cloud.documentai.v1beta2.Document.Style;

Creates a new Style instance using the specified properties.

Parameter
NameDescription
properties IStyle

Properties to set

Returns
TypeDescription
google.cloud.documentai.v1beta2.Document.Style

Style instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta2.Document.Style;

Decodes a Style message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.documentai.v1beta2.Document.Style

Style

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta2.Document.Style;

Decodes a Style message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.documentai.v1beta2.Document.Style

Style

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta2.Document.IStyle, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Style message. Does not implicitly messages.

Parameters
NameDescription
message IStyle

Style message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.documentai.v1beta2.Document.IStyle, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Style message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IStyle

Style message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1beta2.Document.Style;

Creates a Style message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.documentai.v1beta2.Document.Style

Style

toJSON()

public toJSON(): { [k: string]: any };

Converts this Style to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta2.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
NameDescription
message google.cloud.documentai.v1beta2.Document.Style

Style

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Style message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not