Skip to content
ChartForgeX

API Reference

Class

MermaidDiagramNote

Edit on GitHub
Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Source MermaidDiagramNote.cs:8
Base MermaidAstNode
Modifiers sealed

A visible diagram note, separate from the graph's semantic nodes.

Inheritance

Usage

Explore 2 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 2

Constructors

public MermaidDiagramNote(String text, String? nodeId, Boolean leftOfNode, MermaidSourceSpan span) #
MermaidDiagramNote.cs:8

Creates a note with its authored text, optional attachment, and source location.

Parameters

text System.String requiredposition: 0
nodeId System.String? requiredposition: 1
leftOfNode System.Boolean requiredposition: 2
span ChartForgeX.Mermaid.MermaidSourceSpan requiredposition: 3

Properties

public String Text { get; } #
MermaidDiagramNote.cs:15

Gets the visible note text, including authored line breaks.

public String? NodeId { get; } #
MermaidDiagramNote.cs:18

Gets the attached class or state id, or null for a floating note.

public Boolean LeftOfNode { get; } #
MermaidDiagramNote.cs:21

Gets whether an attached note is placed to the left of its node.