portgraph 0.16.1

Data structure library for directed graphs with first-level ports.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! Layout algorithms for Mermaid rendering.

use crate::LinkView;

use super::MermaidBuilder;

/// Mermaid graph layout options.
///
/// See <https://mermaid.ai/open-source/config/layouts.html>.
///
/// Defaults to `elk`.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum MermaidLayout {
    /// The layout engine used by default in mermaid.
    ///
    /// This doesn't require adding a configuration block to the mermaid
    /// definition, but it has limited layout options and may produce less
    /// readable diagrams.
    Dagre,
    /// Eclipse Layout Kernel, a more advanced layout engine with tighter
    /// node placement.
    ///
    /// See <https://eclipse.dev/elk/>
    #[default]
    Elk,
}

impl MermaidLayout {
    /// Returns `True` if the layout config requires an explicit
    /// configuration block in the mermaid definition.
    pub fn requires_config(&self) -> bool {
        match self {
            MermaidLayout::Dagre => false,
            MermaidLayout::Elk => true,
        }
    }

    /// Emit the mermaid configuration block for this layout.
    pub(super) fn emit_config(&self, builder: &mut MermaidBuilder<'_, impl LinkView>) {
        match self {
            MermaidLayout::Dagre => {}
            MermaidLayout::Elk => {
                builder.push_line("layout: elk");
            }
        }
    }
}