Skip to main content

FrameRequest

Struct FrameRequest 

Source
#[non_exhaustive]
pub struct FrameRequest { pub viewport: Viewport, pub pointer: Option<Pointer>, pub caption: Option<String>, pub column_widths: Option<Vec<u32>>, }
Expand description

Inputs for one frame.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§viewport: Viewport

Window. origin_* scrolls; pixmap is the visible remainder, capped.

§pointer: Option<Pointer>

Optional pointer for hover fill + tooltip PNG (pixmap space).

§caption: Option<String>

Optional caption. Painted as glyphs. Included in host text only when copyable.

§column_widths: Option<Vec<u32>>

Host column widths in pixels. None measures from the viewed grid. Extra entries are ignored; missing columns are measured.

Implementations§

Source§

impl FrameRequest

Source

pub fn full(viewport: Viewport) -> Self

Full default origin, no pointer, measured columns.

Examples found in repository?
examples/gallery.rs (line 540)
539    fn request(&self, spec: &Spec, pointer: Option<Pointer>) -> FrameRequest {
540        let mut req = FrameRequest::full(spec.viewport);
541        if let Some(c) = spec.caption {
542            req = req.caption(c);
543        }
544        if let Some(w) = spec.widths.clone() {
545            req = req.column_widths(w);
546        }
547        if let Some(p) = pointer {
548            req = req.pointer(p);
549        }
550        req
551    }
More examples
Hide additional examples
examples/scroll_resize.rs (line 57)
14fn main() -> Result<(), Box<dyn std::error::Error>> {
15    let mut rows = Vec::new();
16    for i in 0..40u32 {
17        rows.push(Row::new(
18            i,
19            vec![
20                CellValue::text(format!("SKU-{i:03}")),
21                CellValue::float(10.0 + f64::from(i), 2),
22                CellValue::int(i64::from(i) * 3),
23            ],
24        ));
25    }
26    let grid = Grid::try_new(
27        vec![
28            Column::new(0, "sku"),
29            Column::new(1, "price"),
30            Column::new(2, "qty"),
31        ],
32        rows,
33    )?;
34
35    let surface = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
36    let metrics = surface.metrics(&grid);
37    let dir = renders_dir();
38    fs::create_dir_all(&dir)?;
39
40    let window = Viewport::window(420, 140);
41    let frames = [
42        ("scroll_y0.png", window.clamp_to(&metrics), None),
43        ("scroll_y90.png", window.scroll_by(0, 90, &metrics), None),
44        (
45            "scroll_clamped.png",
46            window.scroll_by(0, 9_999, &metrics),
47            None,
48        ),
49        (
50            "resize_sku200.png",
51            window,
52            Some(metrics.resize_column(0, 200)),
53        ),
54    ];
55
56    for (name, vp, widths) in frames {
57        let mut req = FrameRequest::full(vp);
58        if let Some(w) = widths {
59            req = req.column_widths(w);
60        }
61        let frame = surface.render(&grid, &req)?;
62        let path = dir.join(name);
63        fs::write(&path, &frame.png)?;
64        println!(
65            "{name}: origin_y={} visible {}..{} bytes={} -> {}",
66            vp.origin_y,
67            frame.visible_row_start,
68            frame.visible_row_end,
69            frame.png.len(),
70            path.display()
71        );
72    }
73    Ok(())
74}
examples/scatter.rs (line 37)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut a = Vec::new();
17    let mut b = Vec::new();
18    for i in 0..28u32 {
19        let t = f64::from(i);
20        a.push(SeriesPoint::new(
21            6.0 + (t * 0.37).sin() * 5.0 + t * 0.12,
22            22.0 + (t * 0.51).cos() * 8.0,
23        ));
24        b.push(SeriesPoint::new(
25            18.0 + (t * 0.29).cos() * 6.0,
26            12.0 + (t * 0.41).sin() * 7.0 + t * 0.15,
27        ));
28    }
29    a[10] = SeriesPoint::new(12.0, 49.37);
30
31    let layout = SeriesLayout::try_new(vec![Series::new(0, "a", a), Series::new(1, "b", b)])?;
32    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
33    fs::create_dir_all(&dir)?;
34
35    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
36    let vp = Viewport::window(520, 240);
37    let rest = FrameRequest::full(vp).caption("scatter");
38    let idle = sealed.render_scatter(&layout, &rest)?;
39    fs::write(dir.join("sc_sealed.png"), &idle.png)?;
40    fs::write(dir.join("readme_scatter.png"), &idle.png)?;
41
42    let hit = sealed.render_scatter(&layout, &rest.clone().pointer(Pointer::new(240, 110)))?;
43    fs::write(dir.join("sc_crosshair.png"), &hit.png)?;
44    if let Some(tip) = &hit.tooltip_png {
45        fs::write(dir.join("sc_tooltip.png"), tip)?;
46    }
47    println!(
48        "sealed scatter audit={:?} tooltip={}",
49        hit.host.audit_text(),
50        hit.tooltip_png.as_ref().map_or(0, Vec::len)
51    );
52
53    sealed.set_mode(SurfaceMode::Copyable);
54    let copy = sealed.render_scatter(&layout, &rest)?;
55    fs::write(dir.join("sc_copyable.png"), &copy.png)?;
56
57    let trial = Surface::new(
58        SurfaceMode::Sealed,
59        LicenseLens::from_tier(AccessTier::Trial),
60    );
61    let t = trial.render_scatter(&layout, &rest)?;
62    fs::write(dir.join("sc_trial_lens.png"), &t.png)?;
63    println!(
64        "wrote scatter renders; trial viewed rows={}",
65        t.viewed.rows.len()
66    );
67    Ok(())
68}
examples/host_contract.rs (lines 73-78)
37fn main() -> Result<(), Box<dyn std::error::Error>> {
38    let mut rows = Vec::new();
39    for i in 0..80u32 {
40        rows.push(Row::new(
41            i,
42            vec![
43                CellValue::text(format!("ACME-SKU-{i}")),
44                CellValue::float(10.0 + f64::from(i), 2),
45            ],
46        ));
47    }
48    let grid = Grid::try_new(vec![Column::new(0, "sku"), Column::new(1, "price")], rows)?;
49
50    let surface = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
51    let metrics = surface.metrics(&grid);
52
53    // Host scrollbar: window 480×160, content from metrics.
54    let window = Viewport {
55        origin_x: 0,
56        origin_y: 0,
57        width: 480,
58        height: 160,
59    };
60    println!(
61        "host scrollbar: content {}x{} window {}x{} max_origin_y={}",
62        metrics.content_width,
63        metrics.content_height,
64        window.width,
65        window.height,
66        metrics.content_height.saturating_sub(window.height)
67    );
68
69    let dir = std::env::temp_dir().join("sealed-surface-examples");
70    fs::create_dir_all(&dir)?;
71
72    for (name, origin_y) in [("y0", 0u32), ("y180", 180), ("y360", 360)] {
73        let mut req = FrameRequest::full(Viewport {
74            origin_x: 0,
75            origin_y,
76            width: window.width,
77            height: window.height,
78        });
79        req.pointer = Some(Pointer { x: 24, y: 40 });
80        let frame = surface.render(&grid, &req)?;
81        let path = dir.join(format!("host_{name}.png"));
82        fs::write(&path, &frame.png)?;
83        assert!(
84            frame.host.audit_text().is_empty(),
85            "sealed host leaked: {:?}",
86            frame.host.audit_text()
87        );
88        println!(
89            "{name}: rows {}..{} png={} tooltip={} file={}",
90            frame.visible_row_start,
91            frame.visible_row_end,
92            frame.png.len(),
93            frame.tooltip_png.as_ref().map_or(0, Vec::len),
94            path.display()
95        );
96    }
97
98    println!("forbidden: interpolating cell values, tooltip JSON, CSS blur over live rows");
99    println!("allowed:   <img alt=\"\"> + tooltip PNG + metrics-driven origin");
100    Ok(())
101}
examples/treemap.rs (line 46)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let layout = TreeLayout::try_new(TreeNode::branch(
17        0,
18        "catalog",
19        vec![
20            TreeNode::branch(
21                1,
22                "apparel",
23                vec![
24                    TreeNode::leaf(2, "shirts", 42.0),
25                    TreeNode::leaf(3, "pants", 18.0),
26                    TreeNode::leaf(4, "hats", 9.0),
27                ],
28            ),
29            TreeNode::branch(
30                5,
31                "home",
32                vec![
33                    TreeNode::leaf(6, "lamps", 21.0),
34                    TreeNode::leaf(7, "rugs", 14.0),
35                ],
36            ),
37            TreeNode::leaf(8, "other", 7.0),
38        ],
39    ))?;
40
41    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
42    fs::create_dir_all(&dir)?;
43
44    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
45    let vp = Viewport::window(520, 280);
46    let rest = FrameRequest::full(vp).caption("catalog");
47    let idle = sealed.render_tree(&layout, &rest)?;
48    fs::write(dir.join("tm_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_tree.png"), &idle.png)?;
50
51    let hit = sealed.render_tree(&layout, &rest.clone().pointer(Pointer::new(80, 90)))?;
52    fs::write(dir.join("tm_hover.png"), &hit.png)?;
53    if let Some(tip) = &hit.tooltip_png {
54        fs::write(dir.join("tm_tooltip.png"), tip)?;
55    }
56    println!(
57        "sealed tree audit={:?} hits={} tooltip={}",
58        hit.host.audit_text(),
59        hit.hits.len(),
60        hit.tooltip_png.as_ref().map_or(0, Vec::len)
61    );
62
63    sealed.set_mode(SurfaceMode::Copyable);
64    let copy = sealed.render_tree(&layout, &rest)?;
65    fs::write(dir.join("tm_copyable.png"), &copy.png)?;
66    println!(
67        "copyable TSV (120): {:?}",
68        copy.host.audit_text().chars().take(120).collect::<String>()
69    );
70
71    let trial = Surface::new(
72        SurfaceMode::Sealed,
73        LicenseLens::from_tier(AccessTier::Trial),
74    );
75    let t = trial.render_tree(&layout, &rest)?;
76    fs::write(dir.join("tm_trial_lens.png"), &t.png)?;
77    println!(
78        "wrote treemap renders; trial viewed rows={}",
79        t.viewed.rows.len()
80    );
81    Ok(())
82}
examples/timeseries.rs (line 44)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut pts = Vec::new();
17    for i in 0..48u32 {
18        let x = f64::from(i);
19        let y = 40.0 + 12.0 * (x * 0.28).sin() + x * 0.35;
20        pts.push(SeriesPoint::new(x, y));
21    }
22    // Distinct sealed-contract values near the middle of the window.
23    pts[20] = SeriesPoint::new(20.0, 49.37);
24
25    let layout = SeriesLayout::try_new(vec![
26        Series::new(0, "px", pts),
27        Series::new(
28            1,
29            "qty",
30            (0..48u32)
31                .map(|i| {
32                    let x = f64::from(i);
33                    SeriesPoint::new(x, 8.0 + (x * 0.19).cos() * 3.0)
34                })
35                .collect(),
36        ),
37    ])?;
38
39    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
40    fs::create_dir_all(&dir)?;
41
42    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
43    let vp = Viewport::window(520, 240);
44    let rest = FrameRequest::full(vp).caption("px / qty");
45    let rest_hit = rest.clone().pointer(Pointer::new(240, 110));
46
47    let idle = sealed.render_series(&layout, &rest)?;
48    fs::write(dir.join("ts_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_chart.png"), &idle.png)?;
50    let hit = sealed.render_series(&layout, &rest_hit)?;
51    fs::write(dir.join("ts_crosshair.png"), &hit.png)?;
52    if let Some(tip) = &hit.tooltip_png {
53        fs::write(dir.join("ts_tooltip.png"), tip)?;
54    }
55    println!(
56        "sealed audit (must be empty of values): {:?}",
57        hit.host.audit_text()
58    );
59    println!(
60        "crosshair tooltip_png={} hits={}",
61        hit.tooltip_png.as_ref().map_or(0, Vec::len),
62        hit.hits.len()
63    );
64
65    sealed.set_mode(SurfaceMode::Copyable);
66    let copy = sealed.render_series(&layout, &rest)?;
67    fs::write(dir.join("ts_copyable.png"), &copy.png)?;
68    println!("copyable TSV (first 120 chars): {:?}", {
69        let a = copy.host.audit_text();
70        a.chars().take(120).collect::<String>()
71    });
72
73    let trial = Surface::new(
74        SurfaceMode::Sealed,
75        LicenseLens::from_tier(AccessTier::Trial),
76    );
77    let t = trial.render_series(&layout, &rest)?;
78    fs::write(dir.join("ts_trial_lens.png"), &t.png)?;
79    println!(
80        "trial lens viewed rows={} (two sample points per series)",
81        t.viewed.rows.len()
82    );
83
84    println!("wrote {}", dir.display());
85    Ok(())
86}
Source

pub fn pointer(self, pointer: Pointer) -> Self

Pointer in pixmap space (hover + tooltip).

Examples found in repository?
examples/gallery.rs (line 548)
539    fn request(&self, spec: &Spec, pointer: Option<Pointer>) -> FrameRequest {
540        let mut req = FrameRequest::full(spec.viewport);
541        if let Some(c) = spec.caption {
542            req = req.caption(c);
543        }
544        if let Some(w) = spec.widths.clone() {
545            req = req.column_widths(w);
546        }
547        if let Some(p) = pointer {
548            req = req.pointer(p);
549        }
550        req
551    }
More examples
Hide additional examples
examples/scatter.rs (line 42)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut a = Vec::new();
17    let mut b = Vec::new();
18    for i in 0..28u32 {
19        let t = f64::from(i);
20        a.push(SeriesPoint::new(
21            6.0 + (t * 0.37).sin() * 5.0 + t * 0.12,
22            22.0 + (t * 0.51).cos() * 8.0,
23        ));
24        b.push(SeriesPoint::new(
25            18.0 + (t * 0.29).cos() * 6.0,
26            12.0 + (t * 0.41).sin() * 7.0 + t * 0.15,
27        ));
28    }
29    a[10] = SeriesPoint::new(12.0, 49.37);
30
31    let layout = SeriesLayout::try_new(vec![Series::new(0, "a", a), Series::new(1, "b", b)])?;
32    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
33    fs::create_dir_all(&dir)?;
34
35    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
36    let vp = Viewport::window(520, 240);
37    let rest = FrameRequest::full(vp).caption("scatter");
38    let idle = sealed.render_scatter(&layout, &rest)?;
39    fs::write(dir.join("sc_sealed.png"), &idle.png)?;
40    fs::write(dir.join("readme_scatter.png"), &idle.png)?;
41
42    let hit = sealed.render_scatter(&layout, &rest.clone().pointer(Pointer::new(240, 110)))?;
43    fs::write(dir.join("sc_crosshair.png"), &hit.png)?;
44    if let Some(tip) = &hit.tooltip_png {
45        fs::write(dir.join("sc_tooltip.png"), tip)?;
46    }
47    println!(
48        "sealed scatter audit={:?} tooltip={}",
49        hit.host.audit_text(),
50        hit.tooltip_png.as_ref().map_or(0, Vec::len)
51    );
52
53    sealed.set_mode(SurfaceMode::Copyable);
54    let copy = sealed.render_scatter(&layout, &rest)?;
55    fs::write(dir.join("sc_copyable.png"), &copy.png)?;
56
57    let trial = Surface::new(
58        SurfaceMode::Sealed,
59        LicenseLens::from_tier(AccessTier::Trial),
60    );
61    let t = trial.render_scatter(&layout, &rest)?;
62    fs::write(dir.join("sc_trial_lens.png"), &t.png)?;
63    println!(
64        "wrote scatter renders; trial viewed rows={}",
65        t.viewed.rows.len()
66    );
67    Ok(())
68}
examples/treemap.rs (line 51)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let layout = TreeLayout::try_new(TreeNode::branch(
17        0,
18        "catalog",
19        vec![
20            TreeNode::branch(
21                1,
22                "apparel",
23                vec![
24                    TreeNode::leaf(2, "shirts", 42.0),
25                    TreeNode::leaf(3, "pants", 18.0),
26                    TreeNode::leaf(4, "hats", 9.0),
27                ],
28            ),
29            TreeNode::branch(
30                5,
31                "home",
32                vec![
33                    TreeNode::leaf(6, "lamps", 21.0),
34                    TreeNode::leaf(7, "rugs", 14.0),
35                ],
36            ),
37            TreeNode::leaf(8, "other", 7.0),
38        ],
39    ))?;
40
41    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
42    fs::create_dir_all(&dir)?;
43
44    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
45    let vp = Viewport::window(520, 280);
46    let rest = FrameRequest::full(vp).caption("catalog");
47    let idle = sealed.render_tree(&layout, &rest)?;
48    fs::write(dir.join("tm_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_tree.png"), &idle.png)?;
50
51    let hit = sealed.render_tree(&layout, &rest.clone().pointer(Pointer::new(80, 90)))?;
52    fs::write(dir.join("tm_hover.png"), &hit.png)?;
53    if let Some(tip) = &hit.tooltip_png {
54        fs::write(dir.join("tm_tooltip.png"), tip)?;
55    }
56    println!(
57        "sealed tree audit={:?} hits={} tooltip={}",
58        hit.host.audit_text(),
59        hit.hits.len(),
60        hit.tooltip_png.as_ref().map_or(0, Vec::len)
61    );
62
63    sealed.set_mode(SurfaceMode::Copyable);
64    let copy = sealed.render_tree(&layout, &rest)?;
65    fs::write(dir.join("tm_copyable.png"), &copy.png)?;
66    println!(
67        "copyable TSV (120): {:?}",
68        copy.host.audit_text().chars().take(120).collect::<String>()
69    );
70
71    let trial = Surface::new(
72        SurfaceMode::Sealed,
73        LicenseLens::from_tier(AccessTier::Trial),
74    );
75    let t = trial.render_tree(&layout, &rest)?;
76    fs::write(dir.join("tm_trial_lens.png"), &t.png)?;
77    println!(
78        "wrote treemap renders; trial viewed rows={}",
79        t.viewed.rows.len()
80    );
81    Ok(())
82}
examples/timeseries.rs (line 45)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut pts = Vec::new();
17    for i in 0..48u32 {
18        let x = f64::from(i);
19        let y = 40.0 + 12.0 * (x * 0.28).sin() + x * 0.35;
20        pts.push(SeriesPoint::new(x, y));
21    }
22    // Distinct sealed-contract values near the middle of the window.
23    pts[20] = SeriesPoint::new(20.0, 49.37);
24
25    let layout = SeriesLayout::try_new(vec![
26        Series::new(0, "px", pts),
27        Series::new(
28            1,
29            "qty",
30            (0..48u32)
31                .map(|i| {
32                    let x = f64::from(i);
33                    SeriesPoint::new(x, 8.0 + (x * 0.19).cos() * 3.0)
34                })
35                .collect(),
36        ),
37    ])?;
38
39    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
40    fs::create_dir_all(&dir)?;
41
42    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
43    let vp = Viewport::window(520, 240);
44    let rest = FrameRequest::full(vp).caption("px / qty");
45    let rest_hit = rest.clone().pointer(Pointer::new(240, 110));
46
47    let idle = sealed.render_series(&layout, &rest)?;
48    fs::write(dir.join("ts_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_chart.png"), &idle.png)?;
50    let hit = sealed.render_series(&layout, &rest_hit)?;
51    fs::write(dir.join("ts_crosshair.png"), &hit.png)?;
52    if let Some(tip) = &hit.tooltip_png {
53        fs::write(dir.join("ts_tooltip.png"), tip)?;
54    }
55    println!(
56        "sealed audit (must be empty of values): {:?}",
57        hit.host.audit_text()
58    );
59    println!(
60        "crosshair tooltip_png={} hits={}",
61        hit.tooltip_png.as_ref().map_or(0, Vec::len),
62        hit.hits.len()
63    );
64
65    sealed.set_mode(SurfaceMode::Copyable);
66    let copy = sealed.render_series(&layout, &rest)?;
67    fs::write(dir.join("ts_copyable.png"), &copy.png)?;
68    println!("copyable TSV (first 120 chars): {:?}", {
69        let a = copy.host.audit_text();
70        a.chars().take(120).collect::<String>()
71    });
72
73    let trial = Surface::new(
74        SurfaceMode::Sealed,
75        LicenseLens::from_tier(AccessTier::Trial),
76    );
77    let t = trial.render_series(&layout, &rest)?;
78    fs::write(dir.join("ts_trial_lens.png"), &t.png)?;
79    println!(
80        "trial lens viewed rows={} (two sample points per series)",
81        t.viewed.rows.len()
82    );
83
84    println!("wrote {}", dir.display());
85    Ok(())
86}
Source

pub fn caption(self, caption: impl Into<String>) -> Self

Caption painted as glyphs (host text only when copyable).

Examples found in repository?
examples/gallery.rs (line 542)
539    fn request(&self, spec: &Spec, pointer: Option<Pointer>) -> FrameRequest {
540        let mut req = FrameRequest::full(spec.viewport);
541        if let Some(c) = spec.caption {
542            req = req.caption(c);
543        }
544        if let Some(w) = spec.widths.clone() {
545            req = req.column_widths(w);
546        }
547        if let Some(p) = pointer {
548            req = req.pointer(p);
549        }
550        req
551    }
More examples
Hide additional examples
examples/scatter.rs (line 37)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut a = Vec::new();
17    let mut b = Vec::new();
18    for i in 0..28u32 {
19        let t = f64::from(i);
20        a.push(SeriesPoint::new(
21            6.0 + (t * 0.37).sin() * 5.0 + t * 0.12,
22            22.0 + (t * 0.51).cos() * 8.0,
23        ));
24        b.push(SeriesPoint::new(
25            18.0 + (t * 0.29).cos() * 6.0,
26            12.0 + (t * 0.41).sin() * 7.0 + t * 0.15,
27        ));
28    }
29    a[10] = SeriesPoint::new(12.0, 49.37);
30
31    let layout = SeriesLayout::try_new(vec![Series::new(0, "a", a), Series::new(1, "b", b)])?;
32    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
33    fs::create_dir_all(&dir)?;
34
35    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
36    let vp = Viewport::window(520, 240);
37    let rest = FrameRequest::full(vp).caption("scatter");
38    let idle = sealed.render_scatter(&layout, &rest)?;
39    fs::write(dir.join("sc_sealed.png"), &idle.png)?;
40    fs::write(dir.join("readme_scatter.png"), &idle.png)?;
41
42    let hit = sealed.render_scatter(&layout, &rest.clone().pointer(Pointer::new(240, 110)))?;
43    fs::write(dir.join("sc_crosshair.png"), &hit.png)?;
44    if let Some(tip) = &hit.tooltip_png {
45        fs::write(dir.join("sc_tooltip.png"), tip)?;
46    }
47    println!(
48        "sealed scatter audit={:?} tooltip={}",
49        hit.host.audit_text(),
50        hit.tooltip_png.as_ref().map_or(0, Vec::len)
51    );
52
53    sealed.set_mode(SurfaceMode::Copyable);
54    let copy = sealed.render_scatter(&layout, &rest)?;
55    fs::write(dir.join("sc_copyable.png"), &copy.png)?;
56
57    let trial = Surface::new(
58        SurfaceMode::Sealed,
59        LicenseLens::from_tier(AccessTier::Trial),
60    );
61    let t = trial.render_scatter(&layout, &rest)?;
62    fs::write(dir.join("sc_trial_lens.png"), &t.png)?;
63    println!(
64        "wrote scatter renders; trial viewed rows={}",
65        t.viewed.rows.len()
66    );
67    Ok(())
68}
examples/treemap.rs (line 46)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let layout = TreeLayout::try_new(TreeNode::branch(
17        0,
18        "catalog",
19        vec![
20            TreeNode::branch(
21                1,
22                "apparel",
23                vec![
24                    TreeNode::leaf(2, "shirts", 42.0),
25                    TreeNode::leaf(3, "pants", 18.0),
26                    TreeNode::leaf(4, "hats", 9.0),
27                ],
28            ),
29            TreeNode::branch(
30                5,
31                "home",
32                vec![
33                    TreeNode::leaf(6, "lamps", 21.0),
34                    TreeNode::leaf(7, "rugs", 14.0),
35                ],
36            ),
37            TreeNode::leaf(8, "other", 7.0),
38        ],
39    ))?;
40
41    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
42    fs::create_dir_all(&dir)?;
43
44    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
45    let vp = Viewport::window(520, 280);
46    let rest = FrameRequest::full(vp).caption("catalog");
47    let idle = sealed.render_tree(&layout, &rest)?;
48    fs::write(dir.join("tm_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_tree.png"), &idle.png)?;
50
51    let hit = sealed.render_tree(&layout, &rest.clone().pointer(Pointer::new(80, 90)))?;
52    fs::write(dir.join("tm_hover.png"), &hit.png)?;
53    if let Some(tip) = &hit.tooltip_png {
54        fs::write(dir.join("tm_tooltip.png"), tip)?;
55    }
56    println!(
57        "sealed tree audit={:?} hits={} tooltip={}",
58        hit.host.audit_text(),
59        hit.hits.len(),
60        hit.tooltip_png.as_ref().map_or(0, Vec::len)
61    );
62
63    sealed.set_mode(SurfaceMode::Copyable);
64    let copy = sealed.render_tree(&layout, &rest)?;
65    fs::write(dir.join("tm_copyable.png"), &copy.png)?;
66    println!(
67        "copyable TSV (120): {:?}",
68        copy.host.audit_text().chars().take(120).collect::<String>()
69    );
70
71    let trial = Surface::new(
72        SurfaceMode::Sealed,
73        LicenseLens::from_tier(AccessTier::Trial),
74    );
75    let t = trial.render_tree(&layout, &rest)?;
76    fs::write(dir.join("tm_trial_lens.png"), &t.png)?;
77    println!(
78        "wrote treemap renders; trial viewed rows={}",
79        t.viewed.rows.len()
80    );
81    Ok(())
82}
examples/timeseries.rs (line 44)
15fn main() -> Result<(), Box<dyn std::error::Error>> {
16    let mut pts = Vec::new();
17    for i in 0..48u32 {
18        let x = f64::from(i);
19        let y = 40.0 + 12.0 * (x * 0.28).sin() + x * 0.35;
20        pts.push(SeriesPoint::new(x, y));
21    }
22    // Distinct sealed-contract values near the middle of the window.
23    pts[20] = SeriesPoint::new(20.0, 49.37);
24
25    let layout = SeriesLayout::try_new(vec![
26        Series::new(0, "px", pts),
27        Series::new(
28            1,
29            "qty",
30            (0..48u32)
31                .map(|i| {
32                    let x = f64::from(i);
33                    SeriesPoint::new(x, 8.0 + (x * 0.19).cos() * 3.0)
34                })
35                .collect(),
36        ),
37    ])?;
38
39    let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("examples/renders");
40    fs::create_dir_all(&dir)?;
41
42    let mut sealed = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
43    let vp = Viewport::window(520, 240);
44    let rest = FrameRequest::full(vp).caption("px / qty");
45    let rest_hit = rest.clone().pointer(Pointer::new(240, 110));
46
47    let idle = sealed.render_series(&layout, &rest)?;
48    fs::write(dir.join("ts_sealed.png"), &idle.png)?;
49    fs::write(dir.join("readme_chart.png"), &idle.png)?;
50    let hit = sealed.render_series(&layout, &rest_hit)?;
51    fs::write(dir.join("ts_crosshair.png"), &hit.png)?;
52    if let Some(tip) = &hit.tooltip_png {
53        fs::write(dir.join("ts_tooltip.png"), tip)?;
54    }
55    println!(
56        "sealed audit (must be empty of values): {:?}",
57        hit.host.audit_text()
58    );
59    println!(
60        "crosshair tooltip_png={} hits={}",
61        hit.tooltip_png.as_ref().map_or(0, Vec::len),
62        hit.hits.len()
63    );
64
65    sealed.set_mode(SurfaceMode::Copyable);
66    let copy = sealed.render_series(&layout, &rest)?;
67    fs::write(dir.join("ts_copyable.png"), &copy.png)?;
68    println!("copyable TSV (first 120 chars): {:?}", {
69        let a = copy.host.audit_text();
70        a.chars().take(120).collect::<String>()
71    });
72
73    let trial = Surface::new(
74        SurfaceMode::Sealed,
75        LicenseLens::from_tier(AccessTier::Trial),
76    );
77    let t = trial.render_series(&layout, &rest)?;
78    fs::write(dir.join("ts_trial_lens.png"), &t.png)?;
79    println!(
80        "trial lens viewed rows={} (two sample points per series)",
81        t.viewed.rows.len()
82    );
83
84    println!("wrote {}", dir.display());
85    Ok(())
86}
Source

pub fn column_widths(self, widths: Vec<u32>) -> Self

Host-provided column widths (pixels). Missing columns are measured.

Examples found in repository?
examples/gallery.rs (line 545)
539    fn request(&self, spec: &Spec, pointer: Option<Pointer>) -> FrameRequest {
540        let mut req = FrameRequest::full(spec.viewport);
541        if let Some(c) = spec.caption {
542            req = req.caption(c);
543        }
544        if let Some(w) = spec.widths.clone() {
545            req = req.column_widths(w);
546        }
547        if let Some(p) = pointer {
548            req = req.pointer(p);
549        }
550        req
551    }
More examples
Hide additional examples
examples/scroll_resize.rs (line 59)
14fn main() -> Result<(), Box<dyn std::error::Error>> {
15    let mut rows = Vec::new();
16    for i in 0..40u32 {
17        rows.push(Row::new(
18            i,
19            vec![
20                CellValue::text(format!("SKU-{i:03}")),
21                CellValue::float(10.0 + f64::from(i), 2),
22                CellValue::int(i64::from(i) * 3),
23            ],
24        ));
25    }
26    let grid = Grid::try_new(
27        vec![
28            Column::new(0, "sku"),
29            Column::new(1, "price"),
30            Column::new(2, "qty"),
31        ],
32        rows,
33    )?;
34
35    let surface = Surface::new(SurfaceMode::Sealed, LicenseLens::open());
36    let metrics = surface.metrics(&grid);
37    let dir = renders_dir();
38    fs::create_dir_all(&dir)?;
39
40    let window = Viewport::window(420, 140);
41    let frames = [
42        ("scroll_y0.png", window.clamp_to(&metrics), None),
43        ("scroll_y90.png", window.scroll_by(0, 90, &metrics), None),
44        (
45            "scroll_clamped.png",
46            window.scroll_by(0, 9_999, &metrics),
47            None,
48        ),
49        (
50            "resize_sku200.png",
51            window,
52            Some(metrics.resize_column(0, 200)),
53        ),
54    ];
55
56    for (name, vp, widths) in frames {
57        let mut req = FrameRequest::full(vp);
58        if let Some(w) = widths {
59            req = req.column_widths(w);
60        }
61        let frame = surface.render(&grid, &req)?;
62        let path = dir.join(name);
63        fs::write(&path, &frame.png)?;
64        println!(
65            "{name}: origin_y={} visible {}..{} bytes={} -> {}",
66            vp.origin_y,
67            frame.visible_row_start,
68            frame.visible_row_end,
69            frame.png.len(),
70            path.display()
71        );
72    }
73    Ok(())
74}

Trait Implementations§

Source§

impl Clone for FrameRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.