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

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

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ layout Google\Cloud\DocumentAI\V1\Document\Page\Layout

Layout for VisualElement.

↳ type string

Type of the VisualElement.

↳ detected_languages array<Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>

A list of detected languages together with confidence.

getLayout

Layout for VisualElement.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Document\Page\Layout|null

hasLayout

clearLayout

setLayout

Layout for VisualElement.

Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Document\Page\Layout
Returns
TypeDescription
$this

getType

Type of the VisualElement.

Generated from protobuf field string type = 2;

Returns
TypeDescription
string

setType

Type of the VisualElement.

Generated from protobuf field string type = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDetectedLanguages

A list of detected languages together with confidence.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDetectedLanguages

A list of detected languages together with confidence.

Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>
Returns
TypeDescription
$this