Class protos.google.cloud.documentai.v1.Document.Page (3.0.2)

Represents a Page.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.IPage);

Constructs a new Page.

Parameter

Name	Description
properties	`IPage` Properties to set

Properties

blocks

public blocks: google.cloud.documentai.v1.Document.Page.IBlock[];

Page blocks.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IBlock[]

detectedLanguages

public detectedLanguages: google.cloud.documentai.v1.Document.Page.IDetectedLanguage[];

Page detectedLanguages.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IDetectedLanguage[]

dimension

public dimension?: (google.cloud.documentai.v1.Document.Page.IDimension|null);

Page dimension.

Property Value

Type	Description
(google.cloud.documentai.v1.Document.Page.IDimension\|null)

formFields

public formFields: google.cloud.documentai.v1.Document.Page.IFormField[];

Page formFields.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IFormField[]

image

public image?: (google.cloud.documentai.v1.Document.Page.IImage|null);

Page image.

Property Value

Type	Description
(google.cloud.documentai.v1.Document.Page.IImage\|null)

layout

public layout?: (google.cloud.documentai.v1.Document.Page.ILayout|null);

Page layout.

Property Value

Type	Description
(google.cloud.documentai.v1.Document.Page.ILayout\|null)

lines

public lines: google.cloud.documentai.v1.Document.Page.ILine[];

Page lines.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.ILine[]

pageNumber

public pageNumber: number;

Page pageNumber.

Property Value

Type	Description
number

paragraphs

public paragraphs: google.cloud.documentai.v1.Document.Page.IParagraph[];

Page paragraphs.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IParagraph[]

provenance

public provenance?: (google.cloud.documentai.v1.Document.IProvenance|null);

Page provenance.

Property Value

Type	Description
(google.cloud.documentai.v1.Document.IProvenance\|null)

tables

public tables: google.cloud.documentai.v1.Document.Page.ITable[];

Page tables.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.ITable[]

tokens

public tokens: google.cloud.documentai.v1.Document.Page.IToken[];

Page tokens.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IToken[]

transforms

public transforms: google.cloud.documentai.v1.Document.Page.IMatrix[];

Page transforms.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IMatrix[]

visualElements

public visualElements: google.cloud.documentai.v1.Document.Page.IVisualElement[];

Page visualElements.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Page.IVisualElement[]

Methods

create(properties)

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

Creates a new Page instance using the specified properties.

Parameter

Name	Description
properties	`IPage` Properties to set

Returns

Type	Description
google.cloud.documentai.v1.Document.Page	Page instance

decode(reader, length)

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

Decodes a Page message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.documentai.v1.Document.Page	Page

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.documentai.v1.Document.Page	Page

encode(message, writer)

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

Encodes the specified Page message. Does not implicitly messages.

Parameters

Name	Description
message	`IPage` Page 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.IPage, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPage` Page 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;

Creates a Page 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
google.cloud.documentai.v1.Document.Page	Page

toJSON()

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

Converts this Page to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.documentai.v1.Document.Page` Page
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 Page 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