API Reference
Class
MermaidVennDocument
Describes a parsed Mermaid Venn diagram.
Inheritance
- MermaidDocument
- MermaidVennDocument
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.ParseVenn
Accepted by parameters 8
- Extension method MermaidVennDocument.ToPng
- Extension method MermaidVennDocument.ToSvg
- Extension method MermaidVennDocument.ToVennDiagramBlock
- Extension method MermaidVennDocument.ToVisualArtifact
- Method MermaidVennRendering.ToPng
- Method MermaidVennRendering.ToSvg
- Method MermaidVennRendering.ToVennDiagramBlock
- Method MermaidVennRendering.ToVisualArtifact
Constructors
public MermaidVennDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets Venn statements retained in source order.
public List<MermaidVennSet> Sets { get; } #Gets parsed Venn sets.
public List<MermaidVennIntersection> Intersections { get; } #Gets parsed Venn intersections.
public List<MermaidVennTextNode> TextNodes { get; } #Gets parsed Venn text nodes.
public List<MermaidRawStatement> StyleStatements { get; } #Gets style statements retained in source order.
public String? Title { get; set; } #Gets or sets the optional title statement.
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 Byte[] ToPng(MermaidVennDocument document, MermaidVennRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid Venn document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidVennDocument
- options ChartForgeX.Mermaid.MermaidVennRenderOptions? = null
public static String ToSvg(MermaidVennDocument document, MermaidVennRenderOptions? options = null) #Returns:
StringRenders a Mermaid Venn document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidVennDocument
- options ChartForgeX.Mermaid.MermaidVennRenderOptions? = null
public static VennDiagramBlock ToVennDiagramBlock(MermaidVennDocument document, MermaidVennRenderOptions? options = null) #Returns:
VennDiagramBlockConverts a Mermaid Venn document into a reusable Venn visual block.
Parameters
- document ChartForgeX.Mermaid.MermaidVennDocument
- options ChartForgeX.Mermaid.MermaidVennRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidVennDocument document, MermaidVennRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid Venn document in a visual artifact envelope.
Parameters
- document ChartForgeX.Mermaid.MermaidVennDocument
- options ChartForgeX.Mermaid.MermaidVennRenderOptions? = null