Share via

DocumentMermaidFigure interface

Package:
@azure/ai-content-understanding

Figure containing a diagram, such as a flowchart or network diagram.

Extends
DocumentFigure

Properties

content

Diagram content represented using Mermaid syntax.
kind

Figure kind.

Inherited Properties

caption

Figure caption.
description

Description of the figure.
elements

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

List of figure footnotes.
id

Figure identifier.
role

Semantic role of the figure.
source

Encoded source that identifies the position of the figure in the content.
span

Span of the figure in the markdown content.

Property Details

content

Diagram content represented using Mermaid syntax.

content: string

Property Value

string

kind

Figure kind.

kind: "mermaid"

Property Value

"mermaid"

Inherited Property Details

caption

Figure caption.

caption?: DocumentCaption

Property Value

DocumentCaption

Inherited From DocumentFigure.caption

description

Description of the figure.

description?: string

Property Value

string

Inherited From DocumentFigure.description

elements

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

elements?: string[]

Property Value

string[]

Inherited From DocumentFigure.elements

footnotes

List of figure footnotes.

footnotes?: DocumentFootnote[]

Property Value

DocumentFootnote[]

Inherited From DocumentFigure.footnotes

id

Figure identifier.

id: string

Property Value

string

Inherited From DocumentFigure.id

role

Semantic role of the figure.

role?: SemanticRole

Property Value

SemanticRole

Inherited From DocumentFigure.role

source

Encoded source that identifies the position of the figure in the content.

source?: string

Property Value

string

Inherited From DocumentFigure.source

span

Span of the figure in the markdown content.

span?: ContentSpan

Property Value

ContentSpan

Inherited From DocumentFigure.span