Page

google.cloud.documentai.v1beta2.Document. Page

Represents a Page.

Constructor

new Page(propertiesopt)

Constructs a new Page.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta2.Document.IPage <optional>

Properties to set
Implements:
  • IPage

Classes

Block
DetectedLanguage
Dimension
FormField
Layout
Line
Paragraph
Table
Token
VisualElement

Members

blocks :Array.<google.cloud.documentai.v1beta2.Document.Page.IBlock>

Page blocks.

detectedLanguages :Array.<google.cloud.documentai.v1beta2.Document.Page.IDetectedLanguage>

Page detectedLanguages.

dimension :google.cloud.documentai.v1beta2.Document.Page.IDimension|null|undefined

Page dimension.

formFields :Array.<google.cloud.documentai.v1beta2.Document.Page.IFormField>

Page formFields.

layout :google.cloud.documentai.v1beta2.Document.Page.ILayout|null|undefined

Page layout.

lines :Array.<google.cloud.documentai.v1beta2.Document.Page.ILine>

Page lines.

pageNumber :number

Page pageNumber.

paragraphs :Array.<google.cloud.documentai.v1beta2.Document.Page.IParagraph>

Page paragraphs.

tables :Array.<google.cloud.documentai.v1beta2.Document.Page.ITable>

Page tables.

tokens :Array.<google.cloud.documentai.v1beta2.Document.Page.IToken>

Page tokens.

visualElements :Array.<google.cloud.documentai.v1beta2.Document.Page.IVisualElement>

Page visualElements.

Methods

(static) create(propertiesopt) → {google.cloud.documentai.v1beta2.Document.Page}

Creates a new Page instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta2.Document.IPage <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta2.Document.Page}

Decodes a Page message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.documentai.v1beta2.Document.Page}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Page message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.Document.IPage

Page message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.Document.IPage

Page message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.documentai.v1beta2.Document.Page}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.Document.Page

Page
options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a Page message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this Page to JSON.