Page

google.cloud.documentai.v1beta1.Document. Page

Represents a Page.

Constructor

new Page(propertiesopt)

Constructs a new Page.

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

Properties to set

Implements:
  • IPage

Classes

Block
DetectedLanguage
Dimension
FormField
Layout
Line
Paragraph
Table
Token
VisualElement

Members

blocks

Page blocks.

detectedLanguages

Page detectedLanguages.

dimension

Page dimension.

formFields

Page formFields.

layout

Page layout.

lines

Page lines.

pageNumber

Page pageNumber.

paragraphs

Page paragraphs.

tables

Page tables.

tokens

Page tokens.

visualElements

Page visualElements.

Methods

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

Converts this Page to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Page instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.documentai.v1beta1.Document.Page

Page instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta1.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

Returns:
Type Description
google.cloud.documentai.v1beta1.Document.Page

Page

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.v1beta1.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

Returns:
Type Description
google.cloud.documentai.v1beta1.Document.Page

Page

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.v1beta1.Document.IPage

Page message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(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.v1beta1.Document.IPage

Page message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.documentai.v1beta1.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

Returns:
Type Description
google.cloud.documentai.v1beta1.Document.Page

Page

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Page

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(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.v1beta1.Document.Page

Page

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Page message.

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

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not