Package com.azure.ai.documentintelligence.models

Class BoundingRegion

java.lang.Object
com.azure.ai.documentintelligence.models.BoundingRegion
All Implemented Interfaces:
com.azure.json.JsonSerializable<BoundingRegion>
public final class BoundingRegion extends Object implements com.azure.json.JsonSerializable<BoundingRegion>
Bounding polygon on a specific page of the input.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BoundingRegion
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • 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<Double> 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 com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BoundingRegion>
      Throws:
      IOException

    • fromJson

      public static BoundingRegion fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BoundingRegion.