Meziantou.FrameworkWardleyDiagram Class
A Wardley map: the components of a value chain placed by their visibility to the user (vertically) and their evolution, from genesis to commodity (horizontally), with their dependencies, their movements and the forces on them (Mermaid wardley-beta). The coordinates are between 0 and 1.
public sealed class WardleyDiagram : Diagram- Inheritance
DiagramWardleyDiagram
Constructors
| Name | Description |
|---|---|
| WardleyDiagram() | Initializes a new instance of the WardleyDiagram class, without padding: the map is drawn on a canvas of WardleyDiagram.Width by WardleyDiagram.Height pixels, as in Mermaid. |
WardleyDiagram()
WardleyDiagram.csInitializes a new instance of the WardleyDiagram class, without padding: the map is drawn on a canvas of WardleyDiagram.Width by WardleyDiagram.Height pixels, as in Mermaid.
public WardleyDiagram()Properties
| Name | Description |
|---|---|
| Accelerators | Gets the accelerators: the forces that speed up the evolution, drawn as arrows pointing right. |
| Anchors | Gets the anchors: the users or the customers whose needs the value chain serves. |
| Annotations | Gets the numbered annotations. |
| AnnotationsPosition | Gets or sets the position of the top-left corner of the box that lists the texts of the annotations (Mermaid annotations [visibility, evolution]), or null to draw no box. The box stays inside the map. |
| AxisFontSize | Gets or sets the size of the font of the names of the axes, in pixels. The stages are 2 pixels smaller. The default is 12. |
| Components | Gets the components. A component that has the name of an anchor or of a previous component replaces its position. |
| Deaccelerators | Gets the deaccelerators: the forces that slow down the evolution, drawn as arrows pointing left. |
| Evolves | Gets the movements of the components toward a later evolution. The last movement of a component replaces the previous ones. |
| Height | Gets or sets the height of the canvas, in pixels. The default is 600. |
| LabelFontSize | Gets or sets the size of the font of the labels of the components and the links, in pixels. The default is 10. |
| Links | Gets the links between the components. A link to a name that is not on the map is not drawn. |
| MapPadding | Gets or sets the space between the edges of the canvas and the axes, in pixels. The default is 48. |
| NodeLabelOffset | Gets or sets the distance between a component and its label, in pixels. The default is 8. |
| NodeRadius | Gets or sets the radius of the circles of the components, in pixels. The default is 6. |
| Notes | Gets the notes. |
| Pipelines | Gets the pipelines: the variants of a component at different stages of evolution. |
| ShowGrid | Gets or sets a value that indicates whether a grid divides the map in quarters. |
| Stages | Gets the stages of the evolution axis, from left to right (Mermaid evolution). When the list is empty, the stages are Genesis, Custom Built, Product and Commodity. Mermaid needs at least two stages. |
| Width | Gets or sets the width of the canvas, in pixels. The default is 900. |
Accelerators
WardleyDiagram.csGets the accelerators: the forces that speed up the evolution, drawn as arrows pointing right.
public IList<WardleyAccelerator> Accelerators { get; }Property value
Anchors
WardleyDiagram.csGets the anchors: the users or the customers whose needs the value chain serves.
public IList<WardleyAnchor> Anchors { get; }Property value
Annotations
WardleyDiagram.csAnnotationsPosition
WardleyDiagram.csGets or sets the position of the top-left corner of the box that lists the texts of the annotations (Mermaid annotations [visibility, evolution]), or null to draw no box. The box stays inside the map.
public WardleyPosition? AnnotationsPosition { get; set; }Property value
AxisFontSize
WardleyDiagram.csComponents
WardleyDiagram.csGets the components. A component that has the name of an anchor or of a previous component replaces its position.
public IList<WardleyComponent> Components { get; }Property value
Deaccelerators
WardleyDiagram.csGets the deaccelerators: the forces that slow down the evolution, drawn as arrows pointing left.
public IList<WardleyAccelerator> Deaccelerators { get; }Property value
Evolves
WardleyDiagram.csGets the movements of the components toward a later evolution. The last movement of a component replaces the previous ones.
public IList<WardleyEvolve> Evolves { get; }Property value
Height
WardleyDiagram.csLabelFontSize
WardleyDiagram.csLinks
WardleyDiagram.csGets the links between the components. A link to a name that is not on the map is not drawn.
public IList<WardleyLink> Links { get; }Property value
MapPadding
WardleyDiagram.csNodeLabelOffset
WardleyDiagram.csNodeRadius
WardleyDiagram.csNotes
WardleyDiagram.csPipelines
WardleyDiagram.csGets the pipelines: the variants of a component at different stages of evolution.
public IList<WardleyPipeline> Pipelines { get; }Property value
ShowGrid
WardleyDiagram.csStages
WardleyDiagram.csGets the stages of the evolution axis, from left to right (Mermaid evolution). When the list is empty, the stages are Genesis, Custom Built, Product and Commodity. Mermaid needs at least two stages.
public IList<WardleyStage> Stages { get; }Property value
Width
WardleyDiagram.csMethods
| Name | Description |
|---|---|
| AddAccelerator(string, double, double) | Adds an accelerator: a force that speeds up the evolution. |
| AddAnchor(string, double, double) | Adds an anchor. |
| AddAnnotation(int, string, double, double) | Adds a numbered annotation. |
| AddComponent(string, double, double) | Adds a component. |
| AddDeaccelerator(string, double, double) | Adds a deaccelerator: a force that slows down the evolution. |
| AddEvolve(string, double) | Adds a movement of a component toward a later evolution. |
| AddLink(string, string) | Adds a link. |
| AddNote(string, double, double) | Adds a note. |
| AddPipeline(string) | Adds a pipeline to a component. |
AddAccelerator(string, double, double)
WardleyDiagram.csAdds an accelerator: a force that speeds up the evolution.
public WardleyAccelerator AddAccelerator(string name, double visibility, double evolution)Parameters
namestring- The name.
visibilitydouble- The visibility of the arrow, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution of the left end of the arrow, between 0 (left) and 1 (right).
Returns
WardleyAccelerator The accelerator.
AddAnchor(string, double, double)
WardleyDiagram.csAdds an anchor.
public WardleyAnchor AddAnchor(string name, double visibility, double evolution)Parameters
namestring- The name of the anchor.
visibilitydouble- The visibility, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution, between 0 (left) and 1 (right).
Returns
WardleyAnchor The anchor.
AddAnnotation(int, string, double, double)
WardleyDiagram.csAdds a numbered annotation.
public WardleyAnnotation AddAnnotation(int number, string text, double visibility, double evolution)Parameters
numberint- The number.
textstring- The text, listed in the box of the annotations.
visibilitydouble- The visibility of the circle, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution of the circle, between 0 (left) and 1 (right).
Returns
WardleyAnnotation The annotation.
AddComponent(string, double, double)
WardleyDiagram.csAdds a component.
public WardleyComponent AddComponent(string name, double visibility, double evolution)Parameters
namestring- The name of the component.
visibilitydouble- The visibility, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution, between 0 (left) and 1 (right).
Returns
WardleyComponent The component.
AddDeaccelerator(string, double, double)
WardleyDiagram.csAdds a deaccelerator: a force that slows down the evolution.
public WardleyAccelerator AddDeaccelerator(string name, double visibility, double evolution)Parameters
namestring- The name.
visibilitydouble- The visibility of the arrow, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution of the left end of the arrow, between 0 (left) and 1 (right).
Returns
WardleyAccelerator The deaccelerator.
AddEvolve(string, double)
WardleyDiagram.csAdds a movement of a component toward a later evolution.
public WardleyEvolve AddEvolve(string component, double evolution)Parameters
componentstring- The name of the component.
evolutiondouble- The evolution it moves to, between 0 (left) and 1 (right).
Returns
WardleyEvolve The movement.
AddLink(string, string)
WardleyDiagram.csAdds a link.
public WardleyLink AddLink(string source, string target)Parameters
sourcestring- The name of the component that depends on the target.
targetstring- The name of the component the source depends on.
Returns
WardleyLink The link.
AddNote(string, double, double)
WardleyDiagram.csAdds a note.
public WardleyNote AddNote(string text, double visibility, double evolution)Parameters
textstring- The text.
visibilitydouble- The visibility of its start, between 0 (bottom) and 1 (top).
evolutiondouble- The evolution of its start, between 0 (left) and 1 (right).
Returns
WardleyNote The note.
AddPipeline(string)
WardleyDiagram.csAdds a pipeline to a component.
public WardleyPipeline AddPipeline(string parent)