Google Cloud Document Ai V1 Client - Class Layout (1.0.1)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Layout.

Visual element describing a layout unit on a page.

Generated from protobuf message google.cloud.documentai.v1.Document.Page.Layout

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ text_anchor Google\Cloud\DocumentAI\V1\Document\TextAnchor

Text anchor indexing into the Document.text.

↳ confidence float

Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].

↳ bounding_poly Google\Cloud\DocumentAI\V1\BoundingPoly

The bounding polygon for the Layout.

↳ orientation int

Detected orientation for the Layout.

getTextAnchor

Text anchor indexing into the Document.text.

Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Returns
Type Description
Google\Cloud\DocumentAI\V1\Document\TextAnchor|null

hasTextAnchor

clearTextAnchor

setTextAnchor

Text anchor indexing into the Document.text.

Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\Document\TextAnchor
Returns
Type Description
$this

getConfidence

Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].

Generated from protobuf field float confidence = 2;

Returns
Type Description
float

setConfidence

Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].

Generated from protobuf field float confidence = 2;

Parameter
Name Description
var float
Returns
Type Description
$this

getBoundingPoly

The bounding polygon for the Layout.

Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;

Returns
Type Description
Google\Cloud\DocumentAI\V1\BoundingPoly|null

hasBoundingPoly

clearBoundingPoly

setBoundingPoly

The bounding polygon for the Layout.

Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\BoundingPoly
Returns
Type Description
$this

getOrientation

Detected orientation for the Layout.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;

Returns
Type Description
int

setOrientation

Detected orientation for the Layout.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;

Parameter
Name Description
var int
Returns
Type Description
$this