API Reference
Class
MermaidPieDocument
Describes a parsed Mermaid pie chart document.
Inheritance
- MermaidDocument
- MermaidPieDocument
Usage
Explore 9 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Method MermaidParser.ParsePie
Accepted by parameters 8
- Extension method MermaidPieDocument.ToChart
- Extension method MermaidPieDocument.ToPng
- Extension method MermaidPieDocument.ToSvg
- Extension method MermaidPieDocument.ToVisualArtifact
- Method MermaidPieRendering.ToChart
- Method MermaidPieRendering.ToPng
- Method MermaidPieRendering.ToSvg
- Method MermaidPieRendering.ToVisualArtifact
Constructors
public MermaidPieDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw semantic body statements retained for future syntax growth.
public Boolean ShowData { get; set; } #Gets or sets whether Mermaid's optional showData flag was present.
public String? Title { get; set; } #Gets or sets the optional Mermaid pie title.
public List<MermaidPieSlice> Slices { get; } #Gets parsed pie slices in source order.
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #Inherited from MermaidDocument
public Boolean IsDiagnosticOnly { get; } #Inherited from MermaidDocument
public String SourceText { get; set; } #Inherited from MermaidDocument
public MermaidSourceSpan HeaderSpan { get; set; } #Inherited from MermaidDocument
public String Header { get; set; } #Inherited from MermaidDocument
public String? FrontMatter { get; set; } #Inherited from MermaidDocument
public VisualAccessibility Accessibility { get; } #Inherited from MermaidDocument
public String? Theme { get; set; } #Inherited from MermaidDocument
public List<MermaidDirective> Directives { get; } #Inherited from MermaidDocument
public List<MermaidRawStatement> RawStatements { get; } #Inherited from MermaidDocument
Extension Methods
public static Chart ToChart(MermaidPieDocument document, MermaidPieRenderOptions? options = null) #Returns:
ChartConverts a Mermaid pie document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidPieDocument
- options ChartForgeX.Mermaid.MermaidPieRenderOptions? = null
public static Byte[] ToPng(MermaidPieDocument document, MermaidPieRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid pie document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidPieDocument
- options ChartForgeX.Mermaid.MermaidPieRenderOptions? = null
public static String ToSvg(MermaidPieDocument document, MermaidPieRenderOptions? options = null) #Returns:
StringRenders a Mermaid pie document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidPieDocument
- options ChartForgeX.Mermaid.MermaidPieRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidPieDocument document, MermaidPieRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid pie document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidPieDocument
- options ChartForgeX.Mermaid.MermaidPieRenderOptions? = null