chartml-core 5.0.1

ChartML core library: YAML parser, plugin system, element tree, data model
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

//! Render-time options for the three-stage pipeline.
//!
//! Consolidates the scattered `container_width`, `container_height`, and
//! `param_overrides` arguments that the legacy `render_from_yaml_*` family
//! used to take individually. A single `&RenderOptions` parameter threads
//! through every stage (`fetch`, `transform`, `render_prepared_to_svg`,
//! `render_to_svg_async`) so future fields (e.g. `theme`, `density`,
//! `cancel_token`) can be added without breaking signatures.

use crate::params::ParamValues;

/// Render-time knobs for the chartml 5.0 pipeline.
///
/// Defaults preserve every legacy behavior: `width` / `height` of `None`
/// fall through to the spec's `style.width` / `style.height`, then to the
/// renderer's default dimensions (e.g. 800×400 for cartesian charts);
/// `params` of `None` matches the legacy "no param overrides" path. Cloning
/// is cheap — fields are scalar plus a small `HashMap`.
#[derive(Debug, Clone, Default)]
pub struct RenderOptions {
    /// Container width override in CSS pixels. `None` means "use the spec
    /// or the renderer's default".
    pub width: Option<f64>,
    /// Container height override in CSS pixels. `None` means "use the spec
    /// or the renderer's default".
    pub height: Option<f64>,
    /// Interactive parameter values (e.g. dropdown selections) layered on
    /// top of `params:` defaults declared in the YAML. `None` skips param
    /// overrides entirely.
    pub params: Option<ParamValues>,
}

impl RenderOptions {
    /// Build options that only override the canvas size — no param values.
    /// Sugar for the common "I just want a different width/height" call site.
    pub fn with_size(width: Option<f64>, height: Option<f64>) -> Self {
        Self {
            width,
            height,
            params: None,
        }
    }

    /// Borrow the parameter overrides (if any). Matches the
    /// `Option<&ParamValues>` shape every internal callsite already uses.
    pub fn params_ref(&self) -> Option<&ParamValues> {
        self.params.as_ref()
    }
}