Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.documentai.v1.Document.Page.Token.StyleInfo (8.0.0)

Represents a StyleInfo.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.Page.Token.IStyleInfo);

Constructs a new StyleInfo.

Parameter
Name	Description
`properties`	`IStyleInfo` Properties to set

Properties

backgroundColor

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

StyleInfo backgroundColor.

bold

public bold: boolean;

StyleInfo bold.

fontType

public fontType: string;

StyleInfo fontType.

fontWeight

public fontWeight: number;

StyleInfo fontWeight.

handwritten

public handwritten: boolean;

StyleInfo handwritten.

italic

public italic: boolean;

StyleInfo italic.

letterSpacing

public letterSpacing: number;

StyleInfo letterSpacing.

pixelFontSize

public pixelFontSize: number;

StyleInfo pixelFontSize.

smallcaps

public smallcaps: boolean;

StyleInfo smallcaps.

strikeout

public strikeout: boolean;

StyleInfo strikeout.

subscript

public subscript: boolean;

StyleInfo subscript.

superscript

public superscript: boolean;

StyleInfo superscript.

textColor

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

StyleInfo textColor.

underlined

public underlined: boolean;

StyleInfo underlined.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.Page.Token.IStyleInfo): google.cloud.documentai.v1.Document.Page.Token.StyleInfo;

Creates a new StyleInfo instance using the specified properties.

Parameter
Name	Description
`properties`	`IStyleInfo` Properties to set

Returns
Type	Description
`StyleInfo`	StyleInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.Document.Page.Token.StyleInfo;

Decodes a StyleInfo 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
`StyleInfo`	StyleInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Document.Page.Token.StyleInfo;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`StyleInfo`	StyleInfo

encode(message, writer)

public static encode(message: google.cloud.documentai.v1.Document.Page.Token.IStyleInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StyleInfo message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IStyleInfo` StyleInfo 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.v1.Document.Page.Token.IStyleInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IStyleInfo` StyleInfo 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.v1.Document.Page.Token.StyleInfo;

Creates a StyleInfo 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
`StyleInfo`	StyleInfo

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for StyleInfo

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 StyleInfo to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1.Document.Page.Token.StyleInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a StyleInfo message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`StyleInfo` StyleInfo
`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 StyleInfo message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not