API Reference

Class

MermaidEntityRelationshipDocument

Edit on GitHub

Namespace ChartForgeX.Mermaid

Assembly ChartForgeX.Mermaid

Source MermaidEntityRelationshipDocument.cs:14

Base MermaidDocument

Modifiers sealed

Describes a parsed Mermaid entity relationship diagram.

Inheritance

MermaidDocument
MermaidEntityRelationshipDocument

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.ParseEntityRelationship

Accepted by parameters 8

Extension method MermaidEntityRelationshipDocument.ToPng parameter document
Extension method MermaidEntityRelationshipDocument.ToSvg parameter document
Extension method MermaidEntityRelationshipDocument.ToTopologyChart parameter document
Extension method MermaidEntityRelationshipDocument.ToVisualArtifact parameter document
Method MermaidTopologyRendering.ToPng parameter document
Method MermaidTopologyRendering.ToSvg parameter document
Method MermaidTopologyRendering.ToTopologyChart parameter document
Method MermaidTopologyRendering.ToVisualArtifact parameter document

Constructors

public MermaidEntityRelationshipDocument() #

MermaidEntityRelationshipDocument.cs:14

Inherited Methods

Properties

public String? Direction { get; set; } #

MermaidEntityRelationshipDocument.cs:11

Gets or sets the authored whole-diagram direction.

public List<MermaidEntityNode> Entities { get; } #

MermaidEntityRelationshipDocument.cs:14

Gets entities in source order.

public List<MermaidEntityRelationship> Relationships { get; } #

MermaidEntityRelationshipDocument.cs:17

Gets relationships in source order.

Inherited Properties

Extension Methods

public static Byte[] ToPng(MermaidEntityRelationshipDocument document, MermaidTopologyRenderOptions? options = null) #

MermaidTopologyRendering.cs:200

Returns: Byte[]

Renders a Mermaid ER diagram to PNG.

Parameters

document ChartForgeX.Mermaid.MermaidEntityRelationshipDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1

public static String ToSvg(MermaidEntityRelationshipDocument document, MermaidTopologyRenderOptions? options = null) #

MermaidTopologyRendering.cs:182

Returns: String

Renders a Mermaid ER diagram to SVG.

Parameters

document ChartForgeX.Mermaid.MermaidEntityRelationshipDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1

public static TopologyChart ToTopologyChart(MermaidEntityRelationshipDocument document, MermaidTopologyRenderOptions? options = null)

MermaidTopologyRendering.cs:90

Returns: TopologyChart

Converts a Mermaid ER diagram to a topology chart.

Parameters

document ChartForgeX.Mermaid.MermaidEntityRelationshipDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1

public static VisualArtifact ToVisualArtifact(MermaidEntityRelationshipDocument document, MermaidTopologyRenderOptions? options = null)

MermaidTopologyRendering.cs:164

Returns: VisualArtifact

Wraps a Mermaid ER diagram in a visual artifact envelope.

Parameters

document ChartForgeX.Mermaid.MermaidEntityRelationshipDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1