Meziantou.Framework.Mermaid namespace

Classes

NameDescription
MermaidChartA chart of Mermaid: a pie chart, an XY chart, a quadrant chart, a sankey chart, a treemap or a radar chart. It keeps what the Mermaid text says, so MermaidWriter writes it back, and draws it with a Plot of Meziantou.Framework.Charts, which MermaidChart.ToPlot returns to customize the drawing.
MermaidDocumentA diagram read from the Mermaid text format: its content, and the warnings about the valid parts that are not supported. The front matter (title, config), the %%{init: ...}%% directives, the %% comments and the accessibility statements are read for every type of diagram.
MermaidParseExceptionThe exception thrown when a Mermaid text is not valid.
MermaidParseOptionsThe options of MermaidDocument.Parse.
MermaidWriterWrites diagrams and charts as Mermaid text, which MermaidDocument.Parse reads back.
PieChartA pie chart: slices whose angles are proportional to their values, labeled with their percentages, and a legend (Mermaid pie). The slices are drawn clockwise from the top, in their order.
PieSliceA slice of a pie chart: a label and a value, whose share of the total sets the angle of the slice.
QuadrantChartA quadrant chart: points placed on two axes that go from 0 to 1, over a square split into four quadrants, as for a priority or a risk matrix (Mermaid quadrantChart). The quadrants are numbered as in mathematics: 1 is the top right one, 2 the top left one, 3 the bottom left one and 4 the bottom right one.
QuadrantChartColorsThe colors of a QuadrantChart that replace the ones derived from the theme (the quadrant* theme variables of Mermaid). A null color keeps the one of the theme.
QuadrantChartPointA point of a QuadrantChart: a circle at a position from 0 to 1 on each axis, with a text below it.
QuadrantChartPointStyleThe style of a point of a QuadrantChart, or of a class of points. A null value keeps the default.
RadarAxisAn axis of a radar chart: a spoke from the center, with its label at its end.
RadarChartA radar chart, also known as a spider chart: axes around a center, and curves that join a value on each axis, to compare several series over several dimensions (Mermaid radar-beta).
RadarCurveA curve of a radar chart: a value per axis, joined around the center and filled.
SankeyChartA sankey diagram: flows between nodes, drawn as links whose width is proportional to their quantity, between nodes placed in columns (Mermaid sankey). The nodes are the sources and the targets of the links, named by them; the chart is drawn with the SankeyMark<T> of Meziantou.Framework.Charts, whose layout is the one of d3-sankey, which Mermaid uses.
SankeyLinkA link of a sankey diagram: a flow of a quantity from a source node to a target node.
TreemapChartA treemap: a hierarchy drawn as nested rectangles, each leaf with an area proportional to its value, each section around its children with its name and its total (Mermaid treemap). It is drawn with the TreemapMark<T> of Meziantou.Framework.Charts, whose squarified layout is the one of d3-hierarchy that Mermaid uses, and the nodes of each section are sorted by decreasing value.
TreemapNodeA node of a treemap: a section, which groups other nodes, or a leaf, whose value gives its area. As in Mermaid, a node with a TreemapNode.Value is a leaf, and a node without one is a section.
XyChartAn XY chart: bars and lines over an x axis of categories or of numbers, and a y axis of numbers (Mermaid xychart). The chart is drawn with a Plot of XyChart.Width by XyChart.Height pixels: a bar mark or a line mark per series, in the colors of the palette of the XY charts of Mermaid.
XyChartAxisAn axis of an XyChart: its title, its values, and how it is drawn (Mermaid x-axis and y-axis, and the xAxis and yAxis configuration).
XyChartBarSeriesA series of an XyChart drawn as bars (Mermaid bar).
XyChartLineSeriesA series of an XyChart drawn as a line through its values (Mermaid line).
XyChartSeriesA series of values of an XyChart, drawn as bars (XyChartBarSeries) or as a line (XyChartLineSeries). The value at an index belongs to the category at the same index of the x axis.

Structs

NameDescription
MermaidParseErrorAn error of a Mermaid text, with its position.
MermaidWarningA part of a valid Mermaid text that the diagrams do not support, such as a JavaScript callback, and that is ignored.
XyChartAxisRangeThe values an axis of an XyChart goes through, from Start to End (Mermaid start --> end).

Enums

NameDescription
PieLegendPositionThe position of the legend of a pie chart, relative to the pie (Mermaid legendPosition).
QuadrantChartXAxisPositionWhere the texts of the x axis of a QuadrantChart are drawn (Mermaid xAxisPosition).
QuadrantChartYAxisPositionWhere the texts of the y axis of a QuadrantChart are drawn (Mermaid yAxisPosition).
RadarGraticuleThe shape of the scale of a radar chart, and of its curves (Mermaid graticule).
SankeyLabelStyleHow the labels of the nodes of a sankey diagram are drawn (Mermaid labelStyle).
SankeyLinkColoringHow the links of a sankey diagram are colored, from the colors of their nodes (Mermaid linkColor).
SankeyNodeAlignmentHow the nodes of a sankey diagram are placed in columns, as the alignments of d3-sankey (Mermaid nodeAlignment).
XyChartOrientationThe orientation of an XyChart.