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.
| 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 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 |
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 |
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];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLayoutId
Optional. Deprecated. Use PageRef.bounding_poly instead.
Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setLayoutId
Optional. Deprecated. Use PageRef.bounding_poly instead.
Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\BoundingPoly|null | |
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];
| 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].
Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |