API Reference
Class
MermaidEventModelingDocument
Describes a parsed Mermaid Event Modeling diagram.
Inheritance
- MermaidDocument
- MermaidEventModelingDocument
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
Accepted by parameters 8
- Extension method MermaidEventModelingDocument.ToPng
- Extension method MermaidEventModelingDocument.ToSvg
- Extension method MermaidEventModelingDocument.ToTopologyChart
- Extension method MermaidEventModelingDocument.ToVisualArtifact
- Method MermaidEventModelingRendering.ToPng
- Method MermaidEventModelingRendering.ToSvg
- Method MermaidEventModelingRendering.ToTopologyChart
- Method MermaidEventModelingRendering.ToVisualArtifact
Constructors
public MermaidEventModelingDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets retained non-empty Event Modeling statements.
public List<MermaidEventModelingFrame> Frames { get; } #Gets parsed timeframe and reset-frame entries in source order.
public List<MermaidEventModelingDataBlock> DataBlocks { get; } #Gets parsed data blocks keyed by their Mermaid identifier.
public List<MermaidEventModelingRelation> Relations { get; } #Gets inferred and explicit timeframe relations in render order.
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(MermaidEventModelingDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
Byte[]Renders an Event Modeling document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidEventModelingDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidEventModelingDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
StringRenders an Event Modeling document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidEventModelingDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidEventModelingDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
TopologyChartConverts an Event Modeling document into a renderer-independent ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidEventModelingDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidEventModelingDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
VisualArtifactWraps an Event Modeling document in a visual artifact envelope backed by a ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidEventModelingDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null