visgraph 0.1.0

Visualize Graphs as Images with one Function Call.
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

#![doc = include_str!("../README.md")]
#![warn(missing_debug_implementations, missing_docs)]

mod errors;
#[cfg(feature = "img")]
pub mod graph_to_img;
pub mod graph_to_svg;
pub mod layout;
pub mod settings;
#[cfg(feature = "img")]
pub mod svg_to_img;

#[cfg(feature = "img")]
pub use graph_to_img::graph_to_img;
pub use graph_to_svg::graph_to_svg;
pub use layout::{hierarchical::Orientation, Layout};

#[cfg(test)]
#[allow(missing_docs)]
pub mod tests {
    use petgraph::graph::{EdgeIndex, NodeIndex, UnGraph};

    use crate::{
        layout::DefaultPositionMapFn,
        settings::{DefaultEdgeLabelFn, DefaultNodeLabelFn, Settings, SettingsBuilder},
        Layout,
    };

    /// Create a test graph with custom node and edge labels, along with the corresponding settings.
    ///
    /// The same as in `examples/custom_labels.rs`
    #[allow(clippy::type_complexity)]
    pub fn custom_labels_test_case() -> (
        UnGraph<String, ()>,
        Settings<DefaultPositionMapFn, impl Fn(NodeIndex) -> String, impl Fn(EdgeIndex) -> String>,
    ) {
        let mut graph = UnGraph::new_undirected();
        let node_a = graph.add_node("Ljubljana".to_string());
        let node_b = graph.add_node("Bielefeld".to_string());
        let node_c = graph.add_node("Cape Town".to_string());
        let node_d = graph.add_node("Lima".to_string());

        graph.add_edge(node_a, node_b, ());
        graph.add_edge(node_b, node_c, ());
        graph.add_edge(node_c, node_d, ());
        graph.add_edge(node_d, node_a, ());

        let graph_clone = graph.clone();

        let node_labels = move |node_id| graph_clone.node_weight(node_id).unwrap().to_owned();
        let edge_labels = |_| "An edge".to_string();

        let settings = SettingsBuilder::new()
            .width(1000.0)
            .height(1000.0)
            .node_radius(50.0)
            .margin_x(0.1)
            .margin_y(0.1)
            .layout(Layout::Circular)
            .node_label_fn(node_labels)
            .edge_label_fn(edge_labels)
            .build()
            .expect("Values should be valid.");

        (graph, settings)
    }

    /// Create a test square graph with a custom position map, along with the corresponding
    /// settings.
    ///
    /// The same as in `examples/position_map.rs`
    #[allow(clippy::type_complexity)]
    pub fn position_map_test_case() -> (
        UnGraph<(), ()>,
        Settings<impl Fn(NodeIndex) -> (f32, f32), DefaultNodeLabelFn, DefaultEdgeLabelFn>,
    ) {
        let mut square_graph = UnGraph::new_undirected();
        let node_a = square_graph.add_node(());
        let node_b = square_graph.add_node(());
        let node_c = square_graph.add_node(());
        let node_d = square_graph.add_node(());

        square_graph.add_edge(node_a, node_b, ());
        square_graph.add_edge(node_b, node_c, ());
        square_graph.add_edge(node_c, node_d, ());
        square_graph.add_edge(node_d, node_a, ());

        // Positions should be between (0.0) and (1.0)
        let position_map = move |node_id| match node_id {
            id if id == node_a => (0.25, 0.25),
            id if id == node_b => (0.75, 0.25),
            id if id == node_c => (0.75, 0.75),
            id if id == node_d => (0.25, 0.75),
            _ => (0.5, 0.5),
        };

        // Customize settings using the SettingsBuilder.
        let settings = SettingsBuilder::new()
            .width(500.0)
            .height(500.0)
            .position_map(position_map)
            .build()
            .expect("Values should be valid.");
        (square_graph, settings)
    }
}