API Reference
Class
MermaidPacketDocument
Describes a parsed Mermaid packet diagram.
Inheritance
- MermaidDocument
- MermaidPacketDocument
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.ParsePacket
Accepted by parameters 8
- Extension method MermaidPacketDocument.ToPacketLayoutBlock
- Extension method MermaidPacketDocument.ToPng
- Extension method MermaidPacketDocument.ToSvg
- Extension method MermaidPacketDocument.ToVisualArtifact
- Method MermaidPacketRendering.ToPacketLayoutBlock
- Method MermaidPacketRendering.ToPng
- Method MermaidPacketRendering.ToSvg
- Method MermaidPacketRendering.ToVisualArtifact
Constructors
public MermaidPacketDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
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 PacketLayoutBlock ToPacketLayoutBlock(MermaidPacketDocument document, MermaidPacketRenderOptions? options = null) #Returns:
PacketLayoutBlockConverts a Mermaid packet document into a reusable packet-layout visual block.
Parameters
- document ChartForgeX.Mermaid.MermaidPacketDocument
- options ChartForgeX.Mermaid.MermaidPacketRenderOptions? = null
public static Byte[] ToPng(MermaidPacketDocument document, MermaidPacketRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid packet document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidPacketDocument
- options ChartForgeX.Mermaid.MermaidPacketRenderOptions? = null
public static String ToSvg(MermaidPacketDocument document, MermaidPacketRenderOptions? options = null) #Returns:
StringRenders a Mermaid packet document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidPacketDocument
- options ChartForgeX.Mermaid.MermaidPacketRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidPacketDocument document, MermaidPacketRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid packet document in a visual artifact envelope backed by a packet-layout block.
Parameters
- document ChartForgeX.Mermaid.MermaidPacketDocument
- options ChartForgeX.Mermaid.MermaidPacketRenderOptions? = null