Package com.azure.ai.formrecognizer.documentanalysis.models

Class DocumentSelectionMark

java.lang.Object

com.azure.ai.formrecognizer.documentanalysis.models.DocumentSelectionMark

public final class DocumentSelectionMark
extends Object

A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.

Constructor Summary

Constructors

Constructor	Description
DocumentSelectionMark()

Method Summary

Modifier and Type	Method	Description
List<Point>	getBoundingPolygon()	Get the list of coordinates of the bounding polygon for the selection mark.
float	getConfidence()	Get the confidence property: Confidence of correctly extracting the selection mark.
DocumentSelectionMarkState	getSelectionMarkState()	Get the state property: State of the selection mark.
DocumentSpan	getSpan()	Get the span property: Location of the selection mark in the reading order concatenated content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentSelectionMark

public DocumentSelectionMark()

Method Details

getSelectionMarkState

public DocumentSelectionMarkState getSelectionMarkState()

Get the state property: State of the selection mark.

Returns:

the state value.

getBoundingPolygon

public List<Point> getBoundingPolygon()

Get the list of coordinates of the bounding polygon for the selection mark. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.

Returns:

the boundingPolygon value.

getSpan

public DocumentSpan getSpan()

Get the span property: Location of the selection mark in the reading order concatenated content.

Returns:

the span value.

getConfidence

public float getConfidence()

Get the confidence property: Confidence of correctly extracting the selection mark.

Returns:

the confidence value.