API Reference
MermaidRadarDocument
Describes a parsed Mermaid radar diagram document.
Inheritance
- MermaidDocument
- MermaidRadarDocument
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.ParseRadar
Accepted by parameters 8
- Extension method MermaidRadarDocument.ToChart
- Extension method MermaidRadarDocument.ToPng
- Extension method MermaidRadarDocument.ToSvg
- Extension method MermaidRadarDocument.ToVisualArtifact
- Method MermaidRadarRendering.ToChart
- Method MermaidRadarRendering.ToPng
- Method MermaidRadarRendering.ToSvg
- Method MermaidRadarRendering.ToVisualArtifact
Constructors
public MermaidRadarDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets retained raw body statements.
public String? Title { get; set; } #Gets or sets the optional chart title.
public List<MermaidRadarAxis> Axes { get; } #Gets parsed radar axes.
public List<MermaidRadarCurve> Curves { get; } #Gets parsed radar curves.
public Boolean ShowLegend { get; set; } #Gets or sets whether the legend should be shown.
public Double? Minimum { get; set; } #Gets or sets the optional minimum radar scale.
public Double? Maximum { get; set; } #Gets or sets the optional maximum radar scale.
public Int32? Ticks { get; set; } #Gets or sets the optional tick count.
public String? Graticule { get; set; } #Gets or sets the optional Mermaid graticule style.
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #public Boolean IsDiagnosticOnly { get; } #public String SourceText { get; set; } #public MermaidSourceSpan HeaderSpan { get; set; } #public String Header { get; set; } #public String? FrontMatter { get; set; } #public VisualAccessibility Accessibility { get; } #public String? Theme { get; set; } #public List<MermaidDirective> Directives { get; } #public List<MermaidRawStatement> RawStatements { get; } #Extension Methods
public static Chart ToChart(MermaidRadarDocument document, MermaidRadarRenderOptions? options = null) #ChartConverts a Mermaid radar document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidRadarDocument
- options ChartForgeX.Mermaid.MermaidRadarRenderOptions? = null
public static Byte[] ToPng(MermaidRadarDocument document, MermaidRadarRenderOptions? options = null) #Byte[]Renders a Mermaid radar document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidRadarDocument
- options ChartForgeX.Mermaid.MermaidRadarRenderOptions? = null
public static String ToSvg(MermaidRadarDocument document, MermaidRadarRenderOptions? options = null) #StringRenders a Mermaid radar document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidRadarDocument
- options ChartForgeX.Mermaid.MermaidRadarRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidRadarDocument document, MermaidRadarRenderOptions? options = null) #VisualArtifactWraps a Mermaid radar document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidRadarDocument
- options ChartForgeX.Mermaid.MermaidRadarRenderOptions? = null