Meziantou.FrameworkEventModelingDiagram Class
An event model: a timeline of frames (screens, processors, commands, read models and events) placed in swimlanes, left to right in order, with the relations between them inferred or explicit (Mermaid eventmodeling).
public sealed class EventModelingDiagram : Diagram- Inheritance
DiagramEventModelingDiagram
Constructors
| Name | Description |
|---|---|
| EventModelingDiagram() |
EventModelingDiagram()
EventModelingDiagram.cspublic EventModelingDiagram()No documentation is available.
Properties
| Name | Description |
|---|---|
| DataBlocks | Gets the data blocks that frames reference. |
| Entities | Gets the names of the declared entities (Mermaid entity), which the scenarios name. They are not drawn. |
| Frames | Gets the frames of the timeline, drawn left to right in order. |
| Notes | Gets the notes attached to frames. They are not drawn. |
| Scenarios | Gets the given/when/then scenarios of frames (Mermaid gwt). They are not drawn. |
DataBlocks
EventModelingDiagram.csGets the data blocks that frames reference.
public IList<EventModelingDataBlock> DataBlocks { get; }Property value
Entities
EventModelingDiagram.csGets the names of the declared entities (Mermaid entity), which the scenarios name. They are not drawn.
Property value
Frames
EventModelingDiagram.csGets the frames of the timeline, drawn left to right in order.
public IList<EventModelingFrame> Frames { get; }Property value
Gets the notes attached to frames. They are not drawn.
public IList<EventModelingNote> Notes { get; }Property value
Scenarios
EventModelingDiagram.csGets the given/when/then scenarios of frames (Mermaid gwt). They are not drawn.
public IList<EventModelingScenario> Scenarios { get; }Property value
Methods
| Name | Description |
|---|---|
| AddFrame(string, EventModelingEntityKind, string) | Adds a frame at the end of the timeline. |
| Find(string) | Finds a frame by identifier. |
AddFrame(string, EventModelingEntityKind, string)
EventModelingDiagram.csAdds a frame at the end of the timeline.
public EventModelingFrame AddFrame(string id, EventModelingEntityKind kind, string entity)Parameters
idstring- The identifier: one to three digits, unique in the diagram.
kindEventModelingEntityKind- The kind of the entity of the frame.
entitystring- The name of the entity, such as
AddItem, orCart.AddItemto put it in the swimlane of the namespaceCart.
Returns
EventModelingFrame The frame.
Find(string)
EventModelingDiagram.csFinds a frame by identifier.
public EventModelingFrame? Find(string id)