perspective-viewer 5.4.0

A data visualization and analytics component, especially well-suited for large and/or streaming datasets.
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

// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
// ┃ Copyright (c) 2017, the Perspective Authors.                              ┃
// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
// ┃ This file is part of the Perspective library, distributed under the terms ┃
// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

//! Associates a single, build-time CSS bundle with a `yew::Component` tree
//! rendered into a Custom Element's `ShadowRoot`.
//!
//! Each `src/css` file is inlined and minified by `lightningcss` (see
//! `build.rs` + the `_viewer_bundle.css` and per-popup `_column_dropdown.css`
//! / `_filter_dropdown.css` / `_function_dropdown.css` / `_dropdown_menu.css`
//! entrypoints) into one stylesheet per "surface". A `<StyleProvider>` at the
//! root of a shadow tree adopts its surface's stylesheet exactly once;
//! constructed `CSSStyleSheet`s are cheap and shared across every viewer
//! instance.
//!
//! # Example
//!
//! ```ignore
//! html! {
//!     <StyleProvider root={host} sheet={StyleSurface::Viewer.sheet()}>
//!         <h1>{ "I am styled!" }</h1>
//!     </StyleProvider>
//! }
//! ```

/// The CSS bundle a shadow tree adopts; each variant maps to one build-time
/// `src/css/_*.css` entrypoint.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum StyleSurface {
    /// The `<perspective-viewer>` ShadowRoot.
    #[default]
    Viewer,
    /// Column-name completion dropdown (inverted color scheme).
    ColumnDropdown,
    /// Filter-value completion dropdown.
    FilterDropdown,
    /// Expression function-completion dropdown.
    FunctionDropdown,
    /// Copy / Export menu (non-inverted color scheme).
    DropdownMenu,
    /// Panel context menu (right-click a panel).
    ContextMenu,
}

impl StyleSurface {
    /// The shared, lazily constructed `CSSStyleSheet` for this surface.
    pub fn sheet(self) -> web_sys::CssStyleSheet {
        match self {
            StyleSurface::Viewer => VIEWER_SHEET.with(|x| x.clone()),
            StyleSurface::ColumnDropdown => COLUMN_DROPDOWN_SHEET.with(|x| x.clone()),
            StyleSurface::FilterDropdown => FILTER_DROPDOWN_SHEET.with(|x| x.clone()),
            StyleSurface::FunctionDropdown => FUNCTION_DROPDOWN_SHEET.with(|x| x.clone()),
            StyleSurface::DropdownMenu => DROPDOWN_MENU_SHEET.with(|x| x.clone()),
            StyleSurface::ContextMenu => CONTEXT_MENU_SHEET.with(|x| x.clone()),
        }
    }
}

/// The viewer-surface bundle: every `src/css` file except the floating-popup
/// sheets. Adopted into the `<perspective-viewer>` ShadowRoot.
fn viewer_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_viewer_bundle.css"))
}

/// Per-popup-surface bundles. Each floating popup root adopts exactly its own
/// self-contained sheet (mirroring the pre-bundle behavior where every popup
/// instance carried only its own CSS) so the four popup styles never collide —
/// in particular `column-dropdown.css`'s `!important` inverted rules stay
/// confined to the column-name completion dropdown.
fn column_dropdown_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_column_dropdown.css"))
}
fn filter_dropdown_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_filter_dropdown.css"))
}
fn function_dropdown_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_function_dropdown.css"))
}
fn dropdown_menu_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_dropdown_menu.css"))
}
fn context_menu_bundle() -> &'static str {
    include_str!(concat!(env!("OUT_DIR"), "/css/_context_menu.css"))
}

thread_local! {
    static VIEWER_SHEET: web_sys::CssStyleSheet = make_sheet(viewer_bundle());
    static COLUMN_DROPDOWN_SHEET: web_sys::CssStyleSheet = make_sheet(column_dropdown_bundle());
    static FILTER_DROPDOWN_SHEET: web_sys::CssStyleSheet = make_sheet(filter_dropdown_bundle());
    static FUNCTION_DROPDOWN_SHEET: web_sys::CssStyleSheet = make_sheet(function_dropdown_bundle());
    static DROPDOWN_MENU_SHEET: web_sys::CssStyleSheet = make_sheet(dropdown_menu_bundle());
    static CONTEXT_MENU_SHEET: web_sys::CssStyleSheet = make_sheet(context_menu_bundle());
}

fn make_sheet(css: &str) -> web_sys::CssStyleSheet {
    let sheet = web_sys::CssStyleSheet::new().unwrap();
    sheet.replace_sync(css).unwrap();
    sheet
}