API Reference
Class
MermaidTreemapDocument
Describes a parsed Mermaid treemap diagram.
Inheritance
- MermaidDocument
- MermaidTreemapDocument
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.ParseTreemap
Accepted by parameters 8
- Extension method MermaidTreemapDocument.ToChart
- Extension method MermaidTreemapDocument.ToPng
- Extension method MermaidTreemapDocument.ToSvg
- Extension method MermaidTreemapDocument.ToVisualArtifact
- Method MermaidTreemapRendering.ToChart
- Method MermaidTreemapRendering.ToPng
- Method MermaidTreemapRendering.ToSvg
- Method MermaidTreemapRendering.ToVisualArtifact
Constructors
public MermaidTreemapDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
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(MermaidTreemapDocument document, MermaidTreemapRenderOptions? options = null) #Returns:
ChartConverts a Mermaid treemap document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidTreemapDocument
- options ChartForgeX.Mermaid.MermaidTreemapRenderOptions? = null
public static Byte[] ToPng(MermaidTreemapDocument document, MermaidTreemapRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid treemap document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidTreemapDocument
- options ChartForgeX.Mermaid.MermaidTreemapRenderOptions? = null
public static String ToSvg(MermaidTreemapDocument document, MermaidTreemapRenderOptions? options = null) #Returns:
StringRenders a Mermaid treemap document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidTreemapDocument
- options ChartForgeX.Mermaid.MermaidTreemapRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidTreemapDocument document, MermaidTreemapRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid treemap document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidTreemapDocument
- options ChartForgeX.Mermaid.MermaidTreemapRenderOptions? = null