dot_ix_model 0.10.0

Model for the `dot_ix` diagramming application.
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

use serde::{Deserialize, Serialize};

use crate::common::dot_src_and_styles::GraphvizImage;

/// Options to pass to graphviz when rendering.
///
/// Currently this is used to pass inline images.
///
/// See [`Options`].
///
/// [`Options`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Options.html
#[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize, Serialize)]
#[serde(default)]
pub struct GraphvizOpts {
    /// The list of [`images`] to pass to `graphviz.layout`.
    ///
    /// [`images`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Image.html
    pub images: Vec<GraphvizImage>,
}

impl GraphvizOpts {
    /// Returns a new `GraphvizOpts` object.
    pub fn new(images: Vec<GraphvizImage>) -> Self {
        Self { images }
    }

    /// Returns the list of [`images`] to pass to `graphviz.layout`.
    ///
    /// [`images`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Image.html
    pub fn images(&self) -> &[GraphvizImage] {
        &self.images
    }
}