jellyflow-layout 0.2.0

Optional headless graph layout adapters for Jellyflow.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use jellyflow_core::{CanvasSize, NodeId};
use serde::{Deserialize, Serialize};

use crate::engine::{
    LayoutDirection, LayoutEngineId, LayoutEngineRequest, LayoutOptions, LayoutRequest,
    LayoutScope, LayoutSpacing,
};

/// Builder for common layout presets.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct LayoutPresetBuilder {
    request: LayoutEngineRequest,
}

impl Default for LayoutPresetBuilder {
    fn default() -> Self {
        Self::workflow()
    }
}

impl LayoutPresetBuilder {
    /// Returns a layered workflow preset.
    pub fn workflow() -> Self {
        Self::new(LayoutEngineId::dugong(), LayoutRequest::all())
    }

    /// Returns a tree-shaped layered preset.
    pub fn tree() -> Self {
        Self::new(LayoutEngineId::tidy_tree(), LayoutRequest::all()).with_options(LayoutOptions {
            direction: LayoutDirection::TopToBottom,
            spacing: LayoutSpacing {
                nodesep: 32.0,
                ranksep: 72.0,
                edgesep: 16.0,
            },
            ..LayoutOptions::default()
        })
    }

    /// Returns a radial mind-map preset.
    pub fn mind_map() -> Self {
        Self::new(LayoutEngineId::mind_map_radial(), LayoutRequest::all())
    }

    /// Returns a freeform mind-map preset.
    pub fn freeform() -> Self {
        Self::new(LayoutEngineId::mind_map_freeform(), LayoutRequest::all()).with_options(
            LayoutOptions {
                spacing: LayoutSpacing {
                    nodesep: 24.0,
                    ranksep: 24.0,
                    edgesep: 24.0,
                },
                ..LayoutOptions::default()
            },
        )
    }

    /// Creates a preset builder for a specific engine.
    pub fn new(engine: impl Into<LayoutEngineId>, layout: LayoutRequest) -> Self {
        Self {
            request: LayoutEngineRequest::new(engine, layout),
        }
    }

    /// Uses a different engine.
    pub fn with_engine(mut self, engine: impl Into<LayoutEngineId>) -> Self {
        self.request.engine = engine.into();
        self
    }

    /// Uses a different layout request.
    pub fn with_layout(mut self, layout: LayoutRequest) -> Self {
        self.request.layout = layout;
        self
    }

    /// Sets layout options.
    pub fn with_options(mut self, options: LayoutOptions) -> Self {
        self.request.layout.options = options;
        self
    }

    /// Uses a different layered layout direction.
    pub fn with_direction(mut self, direction: LayoutDirection) -> Self {
        self.request.layout.options.direction = direction;
        self
    }

    /// Uses a different layered spacing profile.
    pub fn with_spacing(mut self, spacing: LayoutSpacing) -> Self {
        self.request.layout.options.spacing = spacing;
        self
    }

    /// Uses a different margin.
    pub fn with_margin(mut self, margin: CanvasSize) -> Self {
        self.request.layout.options.margin = margin;
        self
    }

    /// Uses a different fallback node size.
    pub fn with_default_node_size(mut self, size: CanvasSize) -> Self {
        self.request.layout.options.default_node_size = size;
        self
    }

    /// Uses a different fallback node origin.
    pub fn with_node_origin(mut self, node_origin: (f32, f32)) -> Self {
        self.request.layout.options.node_origin = node_origin;
        self
    }

    /// Targets all visible nodes.
    pub fn all(mut self) -> Self {
        self.request.layout.scope = LayoutScope::All;
        self
    }

    /// Targets a selected set of nodes.
    pub fn nodes(mut self, nodes: impl IntoIterator<Item = NodeId>) -> Self {
        self.request.layout.scope = LayoutScope::Nodes {
            nodes: nodes.into_iter().collect(),
        };
        self
    }

    /// Uses a different request scope.
    pub fn with_scope(mut self, scope: LayoutScope) -> Self {
        self.request.layout.scope = scope;
        self
    }

    /// Adds request-local measured node sizes.
    pub fn with_measured_node_sizes(
        mut self,
        sizes: impl IntoIterator<Item = (NodeId, CanvasSize)>,
    ) -> Self {
        self.request.layout.measured_node_sizes.extend(sizes);
        self
    }

    /// Builds a layout engine request.
    pub fn build(self) -> LayoutEngineRequest {
        self.request
    }

    /// Returns the layout request without consuming the builder.
    pub fn layout_request(&self) -> LayoutRequest {
        self.request.layout.clone()
    }

    /// Returns the engine request without consuming the builder.
    pub fn engine_request(&self) -> LayoutEngineRequest {
        self.request.clone()
    }
}

impl From<LayoutPresetBuilder> for LayoutEngineRequest {
    fn from(value: LayoutPresetBuilder) -> Self {
        value.build()
    }
}