Class protos.google.cloud.documentai.v1beta2.Document.Page.Layout (2.10.0)

Represents a Layout.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta2.Document.Page.ILayout);

Constructs a new Layout.

Parameter
Name Description
properties ILayout

Properties to set

Properties

boundingPoly

public boundingPoly?: (google.cloud.documentai.v1beta2.IBoundingPoly|null);

Layout boundingPoly.

Property Value
Type Description
(google.cloud.documentai.v1beta2.IBoundingPoly|null)

confidence

public confidence: number;

Layout confidence.

Property Value
Type Description
number

id

public id: string;

Layout id.

Property Value
Type Description
string

orientation

public orientation: (google.cloud.documentai.v1beta2.Document.Page.Layout.Orientation|keyof typeof google.cloud.documentai.v1beta2.Document.Page.Layout.Orientation);

Layout orientation.

Property Value
Type Description
(google.cloud.documentai.v1beta2.Document.Page.Layout.Orientation|keyof typeof google.cloud.documentai.v1beta2.Document.Page.Layout.Orientation)

textAnchor

public textAnchor?: (google.cloud.documentai.v1beta2.Document.ITextAnchor|null);

Layout textAnchor.

Property Value
Type Description
(google.cloud.documentai.v1beta2.Document.ITextAnchor|null)

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta2.Document.Page.ILayout): google.cloud.documentai.v1beta2.Document.Page.Layout;

Creates a new Layout instance using the specified properties.

Parameter
Name Description
properties ILayout

Properties to set
Returns
Type Description
google.cloud.documentai.v1beta2.Document.Page.Layout

Layout instance

decode(reader, length)

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

Decodes a Layout 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.v1beta2.Document.Page.Layout

Layout

decodeDelimited(reader)

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

Decodes a Layout 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.v1beta2.Document.Page.Layout

Layout

encode(message, writer)

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

Encodes the specified Layout message. Does not implicitly messages.

Parameters
Name Description
message ILayout

Layout 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.v1beta2.Document.Page.ILayout, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ILayout

Layout 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.v1beta2.Document.Page.Layout;

Creates a Layout 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.v1beta2.Document.Page.Layout

Layout

toJSON()

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

Converts this Layout to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.documentai.v1beta2.Document.Page.Layout

Layout
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 Layout 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