com.ossuminc.riddl.diagrams.mermaid

Members list

Type members

Classlikes

Attributes

Source
C4Diagram.scala
Supertypes
class Object
trait Matchable
class Any

Context Diagram generator using a DataFlow Diagram from Mermaid

Context Diagram generator using a DataFlow Diagram from Mermaid

Value parameters

context

The context relevant to this diagram

data

The data collected by the ((Diagrams Pass)) for this diagram.

Attributes

Source
ContextMapDiagram.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Generate a data flow diagram Like this:

Generate a data flow diagram Like this:

flowchart TD
 A[Christmas] -->|Get money| B(Go shopping)
 B --> C{Let me think}
 C -->|One| D[Laptop]
 C -->|Two| E[iPhone]
 C -->|Three| F[fa:fa-car Car]

Value parameters

pr

The PassesResult from running the standard passes to obtain all the collected ideas.

Attributes

Source
DataFlowDiagram.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Attributes

Source
DomainMapDiagram.scala
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Attributes

Source
EntityRelationshipDiagram.scala
Supertypes
class Object
trait Matchable
class Any

Flowchart generator abstraction * Example output: *

Flowchart generator abstraction * Example output: *

 * --- * title: "Context Diagram For Domain Foo" * init: *
theme: dark * flowchartConfig: * defaultRenderer: dagre * width: 100% * --- * flowchart LR * classDef default
fill:#666,stroke:black,stroke-width:3px,color:white; * classDef Aclass
font-size:1pc,fill:orange,stroke:black,stroke-width:3; * classDef Bclass
font-size:1pc,fill:#222,stroke:black,stroke-width:3; * classDef Cclass
font-size:1pc,fill:blue,stroke:black,stroke-width:3; * classDef Dclass
font-size:1pc,fill:goldenrod,stroke:black,stroke-width:3; * classDef Eclass
font-size:1pc,fill:green,stroke:black,stroke-width:3; * classDef Fclass
font-size:1pc,fill:chocolate,stroke:black,stroke-width:3; * classDef Gclass
font-size:1pc,fill:purple,stroke:black,stroke-width:3 * subgraph   * A((Christmas))-->|Relates To| B((Go
shopping)) * A -->|Relates To| C((OtherThing)) * A -->|Relates To| G((fa:fa-order Another<br/>Thing)) * A-->|Has An
Extensive</br> Relationship That is</br>Really long|F * A -->|Relates To|
D((fa:fa-laptop<br/>&nbsp;&nbsp;Laptop&nbsp;&nbsp)) * A -->|Relates To| E((fa:fa-phone<br/>iPhone)) * A -->|Relates
To| F((fa:fa-car<br/>Automobile)) * A -->|Relates To| G * end * * class A Aclass * class B Bclass * class C Cclass *
class D Dclass * class E Eclass * class F Fclass * class G Gclass *

*

Attributes

Source
FlowchartDiagramGenerator.scala
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Known subtypes

Common trait for things that generate mermaid diagrams

Common trait for things that generate mermaid diagrams

Attributes

Source
MermaidDiagramGenerator.scala
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion
class
Source
RootOverviewDiagram.scala
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion
object
Source
RootOverviewDiagram.scala
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Show all

A mermaid diagram generator for making sequence diagrams

A mermaid diagram generator for making sequence diagrams

Attributes

Source
SequenceDiagramGenerator.scala
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Known subtypes

A class to generate the sequence diagrams for an Epic's Use Case

A class to generate the sequence diagrams for an Epic's Use Case

Value parameters

ucdd

The UseCaseDiagramData from the DiagramsPass for this

Attributes

Source
UseCaseDiagram.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait FileBuilder
class Object
trait Matchable
class Any
Show all

A trait to be implemented by the user of UseCaseDiagram that provides information that can only be provided from outside UseCaseDiagram itself.

A trait to be implemented by the user of UseCaseDiagram that provides information that can only be provided from outside UseCaseDiagram itself. Note that the PassesResult from running the standard passes is required.

Attributes

Source
UseCaseDiagramSupport.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes