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

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
NameDescription
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::getPage()">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.

↳ 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::getPage()">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
TypeDescription
int|string

setPage

Required. Index into the Document.pages element, for example using <xref uid="\Page\refs::getPage()">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
NameDescription
var int|string
Returns
TypeDescription
$this

getLayoutType

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

Returns
TypeDescription
int

setLayoutType

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLayoutId

Optional. Deprecated. Use PageRef.bounding_poly instead.

Returns
TypeDescription
string

setLayoutId

Optional. Deprecated. Use PageRef.bounding_poly instead.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBoundingPoly

Optional. Identifies the bounding polygon of a layout element on the page.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\BoundingPoly|null

hasBoundingPoly

clearBoundingPoly

setBoundingPoly

Optional. Identifies the bounding polygon of a layout element on the page.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\BoundingPoly
Returns
TypeDescription
$this

getConfidence

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

Returns
TypeDescription
float

setConfidence

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this