Class protos.google.cloud.documentai.v1beta3.Document.Page (8.12.0)

Represents a Page.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new Page.

Parameter
Name Description
properties IPage

Properties to set

Properties

blocks

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

Page blocks.

detectedBarcodes

public detectedBarcodes: google.cloud.documentai.v1beta3.Document.Page.IDetectedBarcode[];

Page detectedBarcodes.

detectedLanguages

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

Page detectedLanguages.

dimension

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

Page dimension.

formFields

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

Page formFields.

image

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

Page image.

imageQualityScores

public imageQualityScores?: (google.cloud.documentai.v1beta3.Document.Page.IImageQualityScores|null);

Page imageQualityScores.

layout

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

Page layout.

lines

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

Page lines.

pageNumber

public pageNumber: number;

Page pageNumber.

paragraphs

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

Page paragraphs.

provenance

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

Page provenance.

symbols

public symbols: google.cloud.documentai.v1beta3.Document.Page.ISymbol[];

Page symbols.

tables

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

Page tables.

tokens

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

Page tokens.

transforms

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

Page transforms.

visualElements

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

Page visualElements.

Methods

create(properties)

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

Creates a new Page instance using the specified properties.

Parameter
Name Description
properties IPage

Properties to set

Returns
Type Description
Page

Page instance

decode(reader, length)

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

Decodes a Page 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
Page

Page

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Page

Page

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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
Page

Page

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Page

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta3.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 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