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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ page
int|string
Required. Index into the Document.pages element, for example using Document.pages 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
↳ 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 Document.pages 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 .
Generated from protobuf field int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
int|string
setPage
Required. Index into the Document.pages element, for example using Document.pages 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 .
Generated from protobuf field int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
var
int|string
$this
getLayoutType
Optional. The type of the layout element that is being referenced if any.
Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
int
setLayoutType
Optional. The type of the layout element that is being referenced if any.
Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getLayoutId
Optional. Deprecated. Use PageRef.bounding_poly instead.
Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
string
setLayoutId
Optional. Deprecated. Use PageRef.bounding_poly instead.
Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
var
string
$this
getBoundingPoly
Optional. Identifies the bounding polygon of a layout element on the page.
Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
hasBoundingPoly
clearBoundingPoly
setBoundingPoly
Optional. Identifies the bounding polygon of a layout element on the page.
Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
$this
getConfidence
Optional. Confidence of detected page element, if applicable. Range [0, 1]
.
Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
float
setConfidence
Optional. Confidence of detected page element, if applicable. Range [0, 1]
.
Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
var
float
$this
