Partilhar via

DocumentFigure Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentFigure

Implements

JsonSerializable<DocumentFigure>

public final class DocumentFigure
implements JsonSerializable<DocumentFigure>

An object representing a figure in the document.

Method Summary

Modifier and Type Method and Description
static DocumentFigure fromJson(JsonReader jsonReader)

Reads an instance of DocumentFigure from the JsonReader.
List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the figure.
DocumentCaption getCaption()

Get the caption property: Caption associated with the figure.
List<String> getElements()

Get the elements property: Child elements of the figure, excluding any caption or footnotes.
List<DocumentFootnote> getFootnotes()

Get the footnotes property: List of footnotes associated with the figure.
String getId()

Get the id property: Figure ID.
List<DocumentSpan> getSpans()

Get the spans property: Location of the figure in the reading order concatenated content.
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 DocumentFigure fromJson(JsonReader jsonReader)

Reads an instance of DocumentFigure from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentFigure 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.

getBoundingRegions

public List getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the figure.

Returns:

the boundingRegions value.

getCaption

public DocumentCaption getCaption()

Get the caption property: Caption associated with the figure.

Returns:

the caption value.

getElements

public List getElements()

Get the elements property: Child elements of the figure, excluding any caption or footnotes.

Returns:

the elements value.

getFootnotes

public List getFootnotes()

Get the footnotes property: List of footnotes associated with the figure.

Returns:

the footnotes value.

getId

public String getId()

Get the id property: Figure ID.

Returns:

the id value.

getSpans

public List getSpans()

Get the spans property: Location of the figure in the reading order concatenated content.

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to