Meziantou.FrameworkArchitectureDiagram Class
An architecture diagram: services drawn as icons, junctions, groups, and edges that leave and reach the services by a given side (Mermaid architecture-beta). The sides of the edges place the services on a grid: an edge from the right of A to the left of B puts B on the right of A.
public sealed class ArchitectureDiagram : Diagram- Inheritance
DiagramArchitectureDiagram
Constructors
| Name | Description |
|---|---|
| ArchitectureDiagram() |
ArchitectureDiagram()
ArchitectureDiagram.cspublic ArchitectureDiagram()No documentation is available.
Properties
| Name | Description |
|---|---|
| Alignments | Gets the alignments: services and junctions placed on a row or a column, in order. |
| Edges | Gets the edges. |
| GroupPadding | Gets or sets the space between the frame of a group and its content, in pixels. The default is 40. |
| Groups | Gets the top-level groups. |
| IconSize | Gets or sets the size of the icons of the services, in pixels. The default is 80. |
| Nodes | Gets the services and the junctions that are in no group, in order. |
Alignments
ArchitectureDiagram.csGets the alignments: services and junctions placed on a row or a column, in order.
public IList<ArchitectureAlignment> Alignments { get; }Property value
GroupPadding
ArchitectureDiagram.csGroups
ArchitectureDiagram.csIconSize
ArchitectureDiagram.csGets the services and the junctions that are in no group, in order.
public IList<ArchitectureNode> Nodes { get; }Property value
Methods
| Name | Description |
|---|---|
| AddEdge(ArchitectureNode, ArchitectureSide, ArchitectureNode, ArchitectureSide) | Adds an edge. |
| AddGroup(string, DiagramText?, string?) | Adds a group that is in no group. |
| AddService(string, DiagramText?, string?) | Adds a service that is in no group. |
| EnumerateGroups() | Enumerates the groups and their nested groups, depth first. |
| EnumerateNodes() | Enumerates the services and the junctions: those in no group, then those of the groups. |
AddEdge(ArchitectureNode, ArchitectureSide, ArchitectureNode, ArchitectureSide)
ArchitectureDiagram.csAdds an edge.
public ArchitectureEdge AddEdge(ArchitectureNode from, ArchitectureSide fromSide, ArchitectureNode to, ArchitectureSide toSide)Parameters
fromArchitectureNode- The first node.
fromSideArchitectureSide- The side of
fromthe edge leaves. toArchitectureNode- The second node.
toSideArchitectureSide- The side of
tothe edge reaches.
Returns
ArchitectureEdge The edge.
AddGroup(string, DiagramText?, string?)
ArchitectureDiagram.csAdds a group that is in no group.
public ArchitectureGroup AddGroup(string id, DiagramText? title = null, string? icon = null)Parameters
idstring- The identifier.
titleDiagramText?- The title, or
nullfor none. iconstring?- The icon shown before the title, or
nullfor none.
Returns
ArchitectureGroup The group.
AddService(string, DiagramText?, string?)
ArchitectureDiagram.csAdds a service that is in no group.
public ArchitectureService AddService(string id, DiagramText? title = null, string? icon = null)Parameters
idstring- The identifier.
titleDiagramText?- The title shown below the icon, or
nullfor none. iconstring?- The icon:
cloud,database,disk,internetorserver, ornullfor none.
Returns
ArchitectureService The service.
EnumerateGroups()
ArchitectureDiagram.csEnumerates the groups and their nested groups, depth first.
public IEnumerable<ArchitectureGroup> EnumerateGroups()Returns
IEnumerable<ArchitectureGroup> The groups.
EnumerateNodes()
ArchitectureDiagram.csEnumerates the services and the junctions: those in no group, then those of the groups.
public IEnumerable<ArchitectureNode> EnumerateNodes()Returns
IEnumerable<ArchitectureNode> The nodes.