Share via

DocumentMermaidFigure Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0

public final class DocumentMermaidFigure
extends DocumentFigure

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

Method Summary

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

Reads an instance of DocumentMermaidFigure from the JsonReader.
String getContent()

Get the content property: Diagram content represented using [Mermaid syntax](https://mermaid.js.org/intro/).
DocumentFigureKind getKind()

Get the kind property: Figure kind.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from DocumentFigure

fromJson getCaption getDescription getElements getFootnotes getId getKind getRole getSource getSpan toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentMermaidFigure fromJson(JsonReader jsonReader)

Reads an instance of DocumentMermaidFigure from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getContent

public String getContent()

Get the content property: Diagram content represented using [Mermaid syntax](https://mermaid.js.org/intro/).

Returns:

the content value.

getKind

public DocumentFigureKind getKind()

Get the kind property: Figure kind.

Overrides:

DocumentMermaidFigure.getKind()

Returns:

the kind value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentMermaidFigure.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to