Google Cloud Document Ai V1 Client - Class PageRef (1.14.0)

Version 1.14.0

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

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

Represents a weak reference to a page element within a document.

Generated from protobuf message google.cloud.documentai.v1.Document.PageAnchor.PageRef

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Document \ PageAnchor

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ page	int|string Required. Index into the Document.pages element, for example using <xref uid="\Page_refs\Page\">Document.pages</xref> to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.
↳ layout_type	int Optional. The type of the layout element that is being referenced if any.
↳ layout_id	string Optional. Deprecated. Use PageRef.bounding_poly instead.
↳ bounding_poly	Google\Cloud\DocumentAI\V1\BoundingPoly Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.
↳ confidence	float Optional. Confidence of detected page element, if applicable. Range [0, 1].

getPage

Required. Index into the Document.pages element, for example using <xref uid="\Page_refs\Page\">Document.pages</xref> to locate the related page element.

This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

Returns
Type	Description
int|string

setPage

Required. Index into the Document.pages element, for example using <xref uid="\Page_refs\Page\">Document.pages</xref> to locate the related page element.

This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getLayoutType

Optional. The type of the layout element that is being referenced if any.

Returns
Type	Description
int

setLayoutType

Optional. The type of the layout element that is being referenced if any.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getLayoutId

Optional. Deprecated. Use PageRef.bounding_poly instead.

Returns
Type	Description
string

setLayoutId

Optional. Deprecated. Use PageRef.bounding_poly instead.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBoundingPoly

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

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

hasBoundingPoly

clearBoundingPoly

setBoundingPoly

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

Parameter
Name	Description
var	Google\Cloud\DocumentAI\V1\BoundingPoly

Returns
Type	Description
$this

getConfidence

Optional. Confidence of detected page element, if applicable. Range [0, 1].

Returns
Type	Description
float

setConfidence

Optional. Confidence of detected page element, if applicable. Range [0, 1].

Parameter
Name	Description
var	float

Returns
Type	Description
$this