Struct FlowChart 

pub struct FlowChart { /* private fields */ }

This is the root struct for an individual flow chart.

Trait Implementations

impl CoreSyntaxFunctions for FlowChart

fn new(direction: FlowDirection) -> Self

Returns a FlowChart struct to allow you to build the necessary markdown text.

fn add_node(&mut self, node_config: SyntaxConfigFile<'_>)

Creates a Mermaid.js Node with the supplied configuration & appends it to the current data of the flow chart struct (i.e. self.data).

fn add_connection(&mut self, connection_config: SyntaxConfigFile<'_>)

Creates a Mermaid.js Connection with the supplied [configuration] & appends it to the current data of the flow chart struct (i.e. self.data).

fn add_linebreak(&mut self, num_of_indents: Option<u8>)

Appends a linebreak & the preceding whitespace to the current data of the flow chart struct (i.e. self.data).

fn build_node_config<'a>( &self, node: &'a Node, id: Option<&'a str>, ) -> SyntaxConfigFile<'a>

This method creates a [NodeConfig] referencing data from a supplied Node.

fn build_connection_config<'a>( &self, connection: &'a Connection, extra_length_num: Option<u8>, ) -> SyntaxConfigFile<'a>

This method creates a [ConnectionConfig] referencing data from a supplied Connection.

fn return_schema(&self) -> String

This method returns a clone of self.data.