API Reference
MermaidParser
Parses Mermaid source into source-preserving document models.
Inheritance
- Object
- MermaidParser
Constructors
public MermaidParser() #Methods
public MermaidParseResult<MermaidDocument> Parse(String source) #MermaidParseResult<MermaidDocument>Parses Mermaid source and detects the diagram family.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidArchitectureDocument> ParseArchitecture(String source) #MermaidParseResult<MermaidArchitectureDocument>Parses Mermaid source as an architecture diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidBlockDocument> ParseBlock(String source) #MermaidParseResult<MermaidBlockDocument>Parses Mermaid source as a block diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidC4Document> ParseC4(String source) #MermaidParseResult<MermaidC4Document>Parses Mermaid source as a C4 diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidClassDocument> ParseClass(String source) #MermaidParseResult<MermaidClassDocument>Parses Mermaid source as a class diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidEntityRelationshipDocument> ParseEntityRelationship(String source) #MermaidParseResult<MermaidEntityRelationshipDocument>Parses Mermaid source as an entity relationship diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidEventModelingDocument> ParseEventModeling(String source) #MermaidParseResult<MermaidEventModelingDocument>Parses Mermaid source as an Event Modeling document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidFlowchartDocument> ParseFlowchart(String source) #MermaidParseResult<MermaidFlowchartDocument>Parses Mermaid source as a flowchart document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidGanttDocument> ParseGantt(String source) #MermaidParseResult<MermaidGanttDocument>Parses Mermaid source as a Gantt diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidGitGraphDocument> ParseGitGraph(String source) #MermaidParseResult<MermaidGitGraphDocument>Parses Mermaid source as a git graph diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidIshikawaDocument> ParseIshikawa(String source) #MermaidParseResult<MermaidIshikawaDocument>Parses Mermaid source as an Ishikawa diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidJourneyDocument> ParseJourney(String source) #MermaidParseResult<MermaidJourneyDocument>Parses Mermaid source as a user journey document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidKanbanDocument> ParseKanban(String source) #MermaidParseResult<MermaidKanbanDocument>Parses Mermaid source as a kanban diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidMindMapDocument> ParseMindMap(String source) #MermaidParseResult<MermaidMindMapDocument>Parses Mermaid source as a mindmap document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidPacketDocument> ParsePacket(String source) #MermaidParseResult<MermaidPacketDocument>Parses Mermaid source as a packet diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidPieDocument> ParsePie(String source) #MermaidParseResult<MermaidPieDocument>Parses Mermaid source as a pie chart document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidQuadrantDocument> ParseQuadrant(String source) #MermaidParseResult<MermaidQuadrantDocument>Parses Mermaid source as a quadrant chart document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidRadarDocument> ParseRadar(String source) #MermaidParseResult<MermaidRadarDocument>Parses Mermaid source as a radar diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidRequirementDocument> ParseRequirement(String source) #MermaidParseResult<MermaidRequirementDocument>Parses Mermaid source as a requirement diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidSankeyDocument> ParseSankey(String source) #MermaidParseResult<MermaidSankeyDocument>Parses Mermaid source as a Sankey diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidSequenceDocument> ParseSequence(String source) #MermaidParseResult<MermaidSequenceDocument>Parses Mermaid source as a sequence diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidStateDocument> ParseState(String source) #MermaidParseResult<MermaidStateDocument>Parses Mermaid source as a state diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidTimelineDocument> ParseTimeline(String source) #MermaidParseResult<MermaidTimelineDocument>Parses Mermaid source as a timeline diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidTreemapDocument> ParseTreemap(String source) #MermaidParseResult<MermaidTreemapDocument>Parses Mermaid source as a treemap diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidTreeViewDocument> ParseTreeView(String source) #MermaidParseResult<MermaidTreeViewDocument>Parses Mermaid source as a tree view document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidVennDocument> ParseVenn(String source) #MermaidParseResult<MermaidVennDocument>Parses Mermaid source as a Venn diagram document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidWardleyDocument> ParseWardley(String source) #MermaidParseResult<MermaidWardleyDocument>Parses Mermaid source as a Wardley map document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
public MermaidParseResult<MermaidXYChartDocument> ParseXYChart(String source) #MermaidParseResult<MermaidXYChartDocument>Parses Mermaid source as an XY chart document.
Parameters
- source System.String
- The Mermaid source text.
Returns
The parse result.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?