DocumentFigure interface
Figure in a document.
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. |
| kind | The discriminator possible values: chart, mermaid |
| 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
caption
description
Description of the figure.
description?: stringProperty Value
string
elements
Child elements of the figure, excluding any caption or footnotes.
elements?: string[]Property Value
string[]
footnotes
id
Figure identifier.
id: stringProperty Value
string
kind
The discriminator possible values: chart, mermaid
kind: DocumentFigureKindProperty Value
role
source
Encoded source that identifies the position of the figure in the content.
source?: stringProperty Value
string