BoundingRegion Class

Package:

com.azure.ai.documentintelligence.models

Maven Artifact:

com.azure:azure-ai-documentintelligence:1.0.0

• java.lang.Object
• • com.azure.ai.documentintelligence.models.BoundingRegion

Implements

JsonSerializable<BoundingRegion>

public final class BoundingRegion
implements JsonSerializable<BoundingRegion>

Bounding polygon on a specific page of the input.

Method Summary

Modifier and Type	Method and Description
static BoundingRegion	fromJson(JsonReader jsonReader) Reads an instance of BoundingRegion from the JsonReader.
int	getPageNumber() Get the pageNumber property: 1-based page number of page containing the bounding region.
List<Double>	getPolygon() Get the polygon property: Bounding polygon on the page, or the entire page if not specified.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static BoundingRegion fromJson(JsonReader jsonReader)

Reads an instance of BoundingRegion from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BoundingRegion if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getPageNumber

public int getPageNumber()

Get the pageNumber property: 1-based page number of page containing the bounding region.

Returns:

the pageNumber value.

getPolygon

public List getPolygon()

Get the polygon property: Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. 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 polygon value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException