FlowchartDiagramGenerator

com.ossuminc.riddl.diagrams.mermaid.FlowchartDiagramGenerator
trait FlowchartDiagramGenerator(val title: String, direction: String) extends MermaidDiagramGenerator

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

Graph
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Concrete methods

def kind: String

Inherited methods

def add(str: String): FileBuilder.this.type

Append a string without indent or suffix

Append a string without indent or suffix

Value parameters

str

The string to append

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
def addIndent(line: String): FileBuilder.this.type

Append an indented line with newline at the end and a level width indent prefix.

Append an indented line with newline at the end and a level width indent prefix. The indent will be done with level * spaces-per-level space characters.

Value parameters

line

The text of the line to be indented

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
def addIndent(): FileBuilder.this.type

Add just the indent spaces

Add just the indent spaces

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
def addLine(line: String): FileBuilder.this.type

Append a line to the buffer with a terminating newline.

Append a line to the buffer with a terminating newline. No prefix is inserted

Value parameters

line

The line to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
def append(text: String): FileBuilder.this.type

Append a line to the buffer without newlines or indentation

Append a line to the buffer without newlines or indentation

Value parameters

text

The text to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
def clear(): Unit

Completely erase the internal buffer

Completely erase the internal buffer

Attributes

Inherited from:
FileBuilder
def decr: FileBuilder.this.type

Decrement the indent by one level

Decrement the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
final protected def frontMatter(): Unit

Attributes

Inherited from:
MermaidDiagramGenerator

Attributes

Inherited from:
MermaidDiagramGenerator
protected def getCssFor(definition: Definition): String

Attributes

Inherited from:
MermaidDiagramGenerator
protected def getIconFor(definition: Definition): String

Attributes

Inherited from:
MermaidDiagramGenerator
protected def getTechnology(definition: Definition): String

Attributes

Inherited from:
MermaidDiagramGenerator
def incr: FileBuilder.this.type

Increment the indent by one level

Increment the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
def nl: FileBuilder.this.type

Append a newline character

Append a newline character

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
protected def spc: String

The number of spaces at the current indent level

The number of spaces at the current indent level

Attributes

Inherited from:
FileBuilder

Convert the buffer to a sequence of strings, one line per string

Convert the buffer to a sequence of strings, one line per string

Attributes

Returns
Inherited from:
FileBuilder
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
FileBuilder -> Any
Inherited from:
FileBuilder

Concrete fields

val title: String

Inherited fields

protected val new_line: String

Attributes

Inherited from:
FileBuilder
protected val spaces_per_level: Int

Attributes

Inherited from:
FileBuilder