API Reference
MermaidQuadrantDocument
Describes a parsed Mermaid quadrant chart.
Inheritance
- MermaidDocument
- MermaidQuadrantDocument
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.ParseQuadrant
Accepted by parameters 8
- Extension method MermaidQuadrantDocument.ToChart
- Extension method MermaidQuadrantDocument.ToPng
- Extension method MermaidQuadrantDocument.ToSvg
- Extension method MermaidQuadrantDocument.ToVisualArtifact
- Method MermaidQuadrantRendering.ToChart
- Method MermaidQuadrantRendering.ToPng
- Method MermaidQuadrantRendering.ToSvg
- Method MermaidQuadrantRendering.ToVisualArtifact
Constructors
public MermaidQuadrantDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw quadrant statements retained with source spans.
public String? Title { get; set; } #Gets or sets the optional Mermaid quadrant title.
public String? XAxisStart { get; set; } #Gets or sets the low-side X axis label.
public String? XAxisEnd { get; set; } #Gets or sets the high-side X axis label.
public String? YAxisStart { get; set; } #Gets or sets the low-side Y axis label.
public String? YAxisEnd { get; set; } #Gets or sets the high-side Y axis label.
public Dictionary<Int32, String> QuadrantLabels { get; } #Gets quadrant labels keyed from 1 to 4.
public List<MermaidQuadrantPoint> Points { get; } #Gets plotted quadrant points in source order.
Inherited Properties
public MermaidSourceSpan HeaderSpan { get; set; } #public VisualAccessibility Accessibility { get; } #public MermaidSourceConfiguration Configuration { get; internal set; } #public List<MermaidDirective> Directives { get; } #public List<MermaidRawStatement> RawStatements { get; } #Extension Methods
public static Chart ToChart(MermaidQuadrantDocument document, MermaidQuadrantRenderOptions? options = null) #ChartConverts a Mermaid quadrant document into a scatter chart with four native background regions.
Parameters
- document ChartForgeX.Mermaid.MermaidQuadrantDocument
- options ChartForgeX.Mermaid.MermaidQuadrantRenderOptions? = null
public static Byte[] ToPng(MermaidQuadrantDocument document, MermaidQuadrantRenderOptions? options = null) #Byte[]Renders a Mermaid quadrant document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidQuadrantDocument
- options ChartForgeX.Mermaid.MermaidQuadrantRenderOptions? = null
public static String ToSvg(MermaidQuadrantDocument document, MermaidQuadrantRenderOptions? options = null) #StringRenders a Mermaid quadrant document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidQuadrantDocument
- options ChartForgeX.Mermaid.MermaidQuadrantRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidQuadrantDocument document, MermaidQuadrantRenderOptions? options = null) #VisualArtifactWraps a Mermaid quadrant document in an artifact backed by native scatter points and quadrant regions.
Parameters
- document ChartForgeX.Mermaid.MermaidQuadrantDocument
- options ChartForgeX.Mermaid.MermaidQuadrantRenderOptions? = null