API Reference
Class
MermaidWardleyDocument
Describes a parsed Mermaid Wardley map.
Inheritance
- MermaidDocument
- MermaidWardleyDocument
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.ParseWardley
Accepted by parameters 8
- Extension method MermaidWardleyDocument.ToPng
- Extension method MermaidWardleyDocument.ToSvg
- Extension method MermaidWardleyDocument.ToVisualArtifact
- Extension method MermaidWardleyDocument.ToWardleyMapBlock
- Method MermaidWardleyRendering.ToPng
- Method MermaidWardleyRendering.ToSvg
- Method MermaidWardleyRendering.ToVisualArtifact
- Method MermaidWardleyRendering.ToWardleyMapBlock
Constructors
public MermaidWardleyDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets Wardley statements retained in source order.
public String? Title { get; set; } #Gets or sets the optional Mermaid title.
public Int32? CanvasWidth { get; set; } #Gets or sets the optional Mermaid canvas width.
public Int32? CanvasHeight { get; set; } #Gets or sets the optional Mermaid canvas height.
public List<MermaidWardleyLink> Links { get; } #Gets parsed dependency links.
public List<MermaidWardleyEvolution> Evolutions { get; } #Gets parsed evolution trends.
public List<MermaidWardleyAnnotation> Annotations { get; } #Gets parsed numbered annotations.
public List<MermaidWardleyMarker> Markers { get; } #Gets parsed accelerators and deaccelerators.
public List<MermaidWardleyPipeline> Pipelines { get; } #Gets parsed pipelines.
Inherited Properties
public MermaidSourceSpan HeaderSpan { get; set; } #Inherited from MermaidDocument
public VisualAccessibility Accessibility { get; } #Inherited from MermaidDocument
public MermaidSourceConfiguration Configuration { get; internal 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(MermaidWardleyDocument document, MermaidWardleyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid Wardley document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidWardleyDocument
- options ChartForgeX.Mermaid.MermaidWardleyRenderOptions? = null
public static String ToSvg(MermaidWardleyDocument document, MermaidWardleyRenderOptions? options = null) #Returns:
StringRenders a Mermaid Wardley document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidWardleyDocument
- options ChartForgeX.Mermaid.MermaidWardleyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidWardleyDocument document, MermaidWardleyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid Wardley document in a visual artifact envelope.
Parameters
- document ChartForgeX.Mermaid.MermaidWardleyDocument
- options ChartForgeX.Mermaid.MermaidWardleyRenderOptions? = null
public static WardleyMapBlock ToWardleyMapBlock(MermaidWardleyDocument document, MermaidWardleyRenderOptions? options = null) #Returns:
WardleyMapBlockConverts a Mermaid Wardley document into a reusable Wardley map block.
Parameters
- document ChartForgeX.Mermaid.MermaidWardleyDocument
- options ChartForgeX.Mermaid.MermaidWardleyRenderOptions? = null