mmdflux 2.1.0

Render Mermaid diagrams as Unicode text, ASCII, SVG, and MMDS JSON.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Shared graph-family derived grid geometry contracts.
//!
//! These types sit between engine-owned float-space solves and downstream
//! grid-space replay. They are graph-owned so callers can derive and hydrate
//! grid geometry without depending on engine-private enums or render-owned
//! namespaces.

mod attachments;
mod backward;
mod bounds;
mod derive;
mod intersect;
mod layout;
mod routing;

pub use derive::geometry_to_grid_layout_with_routed;
#[cfg(test)]
pub(crate) use intersect::{NodeFace, classify_face, face_extent, face_fixed_coord};
#[cfg(test)]
pub(crate) use layout::SelfEdgeDrawData;
pub use layout::{GridLayout, GridPos, NodeBounds, SubgraphBounds};
#[cfg(test)]
pub(crate) use routing::route_edge;
pub use routing::{AttachDirection, Point, RoutedEdge, Segment, route_all_edges};
#[cfg(test)]
pub(crate) use routing::{TextPathFamily, route_edge_with_probe};

pub use crate::graph::projection::OverrideSubgraphProjection;

/// Grid-layout rank assignment strategy.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum GridRanker {
    #[default]
    NetworkSimplex,
    LongestPath,
}

/// Configuration for derived grid layout computation.
///
/// Controls integer-grid spacing, padding, and the underlying layout-derived
/// parameters used by the grid replay pipeline.
#[derive(Debug, Clone)]
pub struct GridLayoutConfig {
    /// Horizontal spacing between nodes.
    pub h_spacing: usize,
    /// Vertical spacing between nodes.
    pub v_spacing: usize,
    /// Padding around the entire diagram.
    pub padding: usize,
    /// Extra left margin for edge labels on left branches.
    pub left_label_margin: usize,
    /// Extra right margin for edge labels on right branches.
    pub right_label_margin: usize,
    /// Ranking algorithm override.
    pub ranker: Option<GridRanker>,
    /// Node spacing (nodesep).
    pub node_sep: f64,
    /// Edge segment spacing (edgesep).
    pub edge_sep: f64,
    /// Rank spacing (ranksep).
    pub rank_sep: f64,
    /// Layout margin (applied in translateGraph).
    pub margin: f64,
    /// Additional ranksep applied when subgraphs are present (Mermaid clusters).
    pub cluster_rank_sep: f64,
}

impl Default for GridLayoutConfig {
    fn default() -> Self {
        Self {
            h_spacing: 4,
            v_spacing: 3,
            padding: 1,
            left_label_margin: 0,
            right_label_margin: 0,
            ranker: None,
            node_sep: 50.0,
            edge_sep: 20.0,
            rank_sep: 50.0,
            margin: 8.0,
            cluster_rank_sep: 25.0,
        }
    }
}