API Reference
MermaidXYChartDocument
Describes a parsed Mermaid XY chart document.
Inheritance
- MermaidDocument
- MermaidXYChartDocument
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.ParseXYChart
Accepted by parameters 8
- Extension method MermaidXYChartDocument.ToChart
- Extension method MermaidXYChartDocument.ToPng
- Extension method MermaidXYChartDocument.ToSvg
- Extension method MermaidXYChartDocument.ToVisualArtifact
- Method MermaidXYChartRendering.ToChart
- Method MermaidXYChartRendering.ToPng
- Method MermaidXYChartRendering.ToSvg
- Method MermaidXYChartRendering.ToVisualArtifact
Constructors
public MermaidXYChartDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets retained raw body statements.
public ChartOrientation Orientation { get; set; } #Gets or sets the requested chart orientation.
public String? Title { get; set; } #Gets or sets the optional chart title.
public MermaidXYChartAxis XAxis { get; } #Gets the optional x-axis declaration.
public MermaidXYChartAxis YAxis { get; } #Gets the optional y-axis declaration.
public List<MermaidXYChartSeries> Series { get; } #Gets parsed bar and line series in source order.
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(MermaidXYChartDocument document, MermaidXYChartRenderOptions? options = null) #ChartConverts a Mermaid XY chart document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidXYChartDocument
- options ChartForgeX.Mermaid.MermaidXYChartRenderOptions? = null
public static Byte[] ToPng(MermaidXYChartDocument document, MermaidXYChartRenderOptions? options = null) #Byte[]Renders a Mermaid XY chart document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidXYChartDocument
- options ChartForgeX.Mermaid.MermaidXYChartRenderOptions? = null
public static String ToSvg(MermaidXYChartDocument document, MermaidXYChartRenderOptions? options = null) #StringRenders a Mermaid XY chart document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidXYChartDocument
- options ChartForgeX.Mermaid.MermaidXYChartRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidXYChartDocument document, MermaidXYChartRenderOptions? options = null) #VisualArtifactWraps a Mermaid XY chart document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidXYChartDocument
- options ChartForgeX.Mermaid.MermaidXYChartRenderOptions? = null