Partilhar via

DocumentFootnote 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.DocumentFootnote

Implements

JsonSerializable<DocumentFootnote>

public final class DocumentFootnote
implements JsonSerializable<DocumentFootnote>

A footnote object describing a table or figure.

Method Summary

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

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

Get the boundingRegions property: Bounding regions covering the footnote.
String getContent()

Get the content property: Content of the footnote.
List<String> getElements()

Get the elements property: Child elements of the footnote.
List<DocumentSpan> getSpans()

Get the spans property: Location of the footnote 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 DocumentFootnote fromJson(JsonReader jsonReader)

Reads an instance of DocumentFootnote from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Returns:

the boundingRegions value.

getContent

public String getContent()

Get the content property: Content of the footnote.

Returns:

the content value.

getElements

public List getElements()

Get the elements property: Child elements of the footnote.

Returns:

the elements value.

getSpans

public List getSpans()

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

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to