Package com.azure.ai.documentintelligence.models

Class DocumentFigure

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentFigure

public final class DocumentFigure
extends Object

An object representing a figure in the document.

Method Summary

Modifier and Type	Method	Description
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.
List<DocumentSpan>	getSpans()	Get the spans property: Location of the figure in the reading order concatenated content.

Methods inherited from class java.lang.Object

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

Method Details

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the figure.

Returns:

the boundingRegions value.

getSpans

public List<DocumentSpan> getSpans()

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

Returns:

the spans value.

getElements

public List<String> getElements()

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

Returns:

the elements value.

getCaption

public DocumentCaption getCaption()

Get the caption property: Caption associated with the figure.

Returns:

the caption value.

getFootnotes

public List<DocumentFootnote> getFootnotes()

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

Returns:

the footnotes value.