@perspective-dev/viewer 5.3.1 → 5.5.0

package/src/ts/ts-rs/{DatetimeColorMode.ts → GetViewMode.ts}

@@ -1,3 +1,6 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 
-export type DatetimeColorMode = "none" | "foreground" | "background";
+/**
+ * How `getView` resolves the `View` it returns.
+ */
+export type GetViewMode = "live" | "clone" | "auto";

package/src/ts/ts-rs/GetViewOptions.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { GetViewMode } from "./GetViewMode.js";
+
+/**
+ * The `getView` argument: the `mode` and the target panel.
+ */
+export type GetViewOptions = { mode?: GetViewMode, panel?: string, };

package/src/ts/ts-rs/RestoreOptions.ts

@@ -17,4 +17,10 @@ panel?: string,
  * The config may be partially applied on failure; restore a
  * known-good config to recover exactly.
  */
-suppress_errors?: boolean, };
+suppress_errors?: boolean, 
+/**
+ * When `true`, a `table` no loaded client hosts yet leaves the panel
+ * empty and pending until the table is created, instead of the default
+ * error.
+ */
+wait_for_table?: boolean, };

package/src/ts/ts-rs/RestoreWorkspaceOptions.ts

@@ -0,0 +1,10 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Options for the `restoreWorkspace()` method.
+ */
+export type RestoreWorkspaceOptions = { 
+/**
+ * As `RestoreOptions::wait_for_table`, applied to every panel entry.
+ */
+wait_for_table?: boolean, };

package/src/ts/ts-rs/ViewOnUpdateResp.ts

@@ -1,3 +1,3 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 
-export type ViewOnUpdateResp = { delta: Array<number>, port_id: number, };
+export type ViewOnUpdateResp = { delta: Uint8Array | undefined, port_id: number, };

package/src/ts/ts-rs/WorkspaceConfigUpdate.ts

@@ -1,33 +1,44 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 import type { Filter } from "./Filter.js";
 import type { Layout } from "./Layout.js";
+import type { OptionalUpdate } from "./OptionalUpdate.js";
 import type { ViewerConfigInitial } from "./ViewerConfigInitial.js";
 
 /**
- * The parse target of a workspace config in
- * [`PerspectiveViewerElement::restoreWorkspace`]. Mirrors
- * [`WorkspaceConfig`], but `panels` entries are [`ViewerConfigInitial`]s —
- * every entry creates a NEW panel, so `table` is required by type (a
- * stray per-panel `settings` key is ignored; it is element-level state,
- * carried by the top-level `active` field).
+ * The [`PerspectiveViewerElement::restoreWorkspace`] argument: a field-wise
+ * update of the element's workspace state, like [`ViewerConfigUpdate`] for a
+ * panel, where an absent key is unchanged, `null` resets and a value
+ * replaces.
  */
-export type WorkspaceConfigUpdate = { active?: string, layout?: Layout, panels: { [key in string]?: ViewerConfigInitial }, 
+export type WorkspaceConfigUpdate = { 
 /**
- * The element-level global (master/detail cross-) filters to re-apply as
- * a transient overlay on every DETAIL panel. Restored as one
- * unattributed bucket: the next selection on any master replaces it.
- * `Option` so an explicit `undefined` property deserializes as
- * `None` like an absent key (also `masters` / `palette` below).
+ * The panel to activate with the settings sidebar open, by `panels` key
+ * or existing panel id; `null` closes the sidebar.
  */
-global_filters?: Array<Filter> | null, 
+active?: OptionalUpdate<string>, 
 /**
- * The master (filter-source) panels, by saved `panels` key. An id not in
- * `panels` warns and is dropped.
+ * The layout tree to stage, naming `panels` keys or existing panel ids.
  */
-masters?: Array<string> | null, 
+layout?: Layout, 
 /**
- * Named color-scale definitions to apply to the host (see
- * [`WorkspaceConfig::palette`]), replacing any previously restored
- * palette.
+ * The complete replacement panel set, each [`ViewerConfigInitial`] entry
+ * creating a new panel (`{}` empties the element); absent keeps the
+ * existing panels.
  */
-palette?: { [key in string]?: string } | null, };
+panels?: { [key in string]?: ViewerConfigInitial }, 
+/**
+ * The element-level cross-filter set applied to every detail panel as
+ * one unattributed bucket, replacing the current set; `null` clears it.
+ */
+global_filters?: OptionalUpdate<Array<Filter>>, 
+/**
+ * The master (filter-source) panels by `panels` key or existing panel
+ * id, unknown ids dropped with a warning; `null` demotes every panel.
+ */
+masters?: OptionalUpdate<Array<string>>, 
+/**
+ * Named color-scale definitions applied to the host (see
+ * [`WorkspaceConfig::palette`]), replacing the previous palette; `null`
+ * clears it.
+ */
+palette?: OptionalUpdate<{ [key in string]?: string }>, };

package/dist/esm/ts-rs/DatetimeColorMode.d.ts

@@ -1 +0,0 @@
-export type DatetimeColorMode = "none" | "foreground" | "background";

package/dist/esm/ts-rs/FormatMode.d.ts

@@ -1 +0,0 @@
-export type FormatMode = "none" | "link" | "bold" | "italics";

package/dist/esm/ts-rs/StringColorMode.d.ts

@@ -1 +0,0 @@
-export type StringColorMode = "none" | "foreground" | "background" | "series";

package/src/css/plugin-settings-panel.css

@@ -1,171 +0,0 @@
-/* ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
- * ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
- * ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
- * ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
- * ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
- * ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
- * ┃ 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). ┃
- * ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
- */
-
-:host {
-    label#edit_mode-label:before {
-        content: var(--psp-label--edit-mode--content);
-    }
-
-    label#scroll_lock-label:before {
-        content: var(--psp-label--scroll-lock--content);
-    }
-
-    label#chart_type-label:before {
-        content: var(--psp-label--chart-type--content);
-    }
-
-    /* viewer-charts plugin_config controls */
-    label#auto_alt_y_axis-label:before {
-        content: var(--psp-label--auto-alt-y-axis--content);
-    }
-
-    label#facet_mode-label:before {
-        content: var(--psp-label--facet-mode--content);
-    }
-
-    label#facet_zoom_mode-label:before {
-        content: var(--psp-label--facet-zoom-mode--content);
-    }
-
-    label#series_zoom_mode-label:before {
-        content: var(--psp-label--series-zoom-mode--content);
-    }
-
-    label#line_width_px-label:before {
-        content: var(--psp-label--line-width-px--content);
-    }
-
-    label#point_size_px-label:before {
-        content: var(--psp-label--point-size-px--content);
-    }
-
-    label#band_inner_frac-label:before {
-        content: var(--psp-label--band-inner-frac--content);
-    }
-
-    label#bar_inner_pad-label:before {
-        content: var(--psp-label--bar-inner-pad--content);
-    }
-
-    label#wick_width_px-label:before {
-        content: var(--psp-label--wick-width-px--content);
-    }
-
-    label#ohlc_line_width_px-label:before {
-        content: var(--psp-label--ohlc-line-width-px--content);
-    }
-
-    label#include_zero-label:before {
-        content: var(--psp-label--include-zero--content);
-    }
-
-    label#domain_mode-label:before {
-        content: var(--psp-label--domain-mode--content);
-    }
-
-    label#gradient_color_mode-label:before {
-        content: var(--psp-label--gradient-color-mode--content);
-    }
-
-    label#gradient_radius_px-label:before {
-        content: var(--psp-label--gradient-radius-px--content);
-    }
-
-    label#gradient_intensity-label:before {
-        content: var(--psp-label--gradient-intensity--content);
-    }
-
-    label#gradient_heat_max-label:before {
-        content: var(--psp-label--gradient-heat-max--content);
-    }
-
-    label#map_tile_provider-label:before {
-        content: var(--psp-label--map-tile-provider--content);
-    }
-
-    label#map_tile_alpha-label:before {
-        content: var(--psp-label--map-tile-alpha--content);
-    }
-
-    label#numeric_axes-label:before {
-        content: var(--psp-label--numeric-axes--content);
-    }
-
-    label#legend_mode-label:before {
-        content: var(--psp-label--legend-mode--content);
-    }
-
-    label#legend_size_mode-label:before {
-        content: var(--psp-label--legend-size-mode--content);
-    }
-
-    label#legend_width_px-label:before {
-        content: var(--psp-label--legend-width-px--content);
-    }
-
-    label#legend_height_px-label:before {
-        content: var(--psp-label--legend-height-px--content);
-    }
-
-    label#legend_anchor-label:before {
-        content: var(--psp-label--legend-anchor--content);
-    }
-
-    label#legend_x-label:before {
-        content: var(--psp-label--legend-x--content);
-    }
-
-    label#legend_y-label:before {
-        content: var(--psp-label--legend-y--content);
-    }
-
-    label#legend_opacity-label:before {
-        content: var(--psp-label--legend-opacity--content);
-    }
-
-    label#tooltip_max_column_px-label:before {
-        content: var(--psp-label--tooltip-max-column-px--content);
-    }
-
-    label#tooltip_opacity-label:before {
-        content: var(--psp-label--tooltip-opacity--content);
-    }
-
-    label#axes-group-label:before {
-        content: var(--psp-label--group-axes--content, "Axes");
-    }
-
-    label#facets-group-label:before {
-        content: var(--psp-label--group-facets--content, "Facets");
-    }
-
-    label#glyph-group-label:before {
-        content: var(--psp-label--group-glyph--content, "Glyphs");
-    }
-
-    label#density-group-label:before {
-        content: var(--psp-label--group-density--content, "Density");
-    }
-
-    label#basemap-group-label:before {
-        content: var(--psp-label--group-basemap--content, "Basemap");
-    }
-
-    label#legend-group-label:before {
-        content: var(--psp-label--group-legend--content, "Legend");
-    }
-
-    label#tooltip-group-label:before {
-        content: var(--psp-label--group-tooltip--content, "Tooltips");
-    }
-}

package/src/rust/components/modal.rs

@@ -1,177 +0,0 @@
-// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
-// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
-// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
-// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
-// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
-// ┃ 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). ┃
-// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-
-use std::cell::Cell;
-use std::marker::PhantomData;
-use std::rc::Rc;
-
-use derivative::Derivative;
-use yew::html::*;
-use yew::prelude::*;
-use yew::virtual_dom::VChild;
-
-use crate::utils::WeakScope;
-
-#[derive(Properties, Derivative)]
-#[derivative(PartialEq(bound = ""))]
-pub struct ModalProps<T>
-where
-    T: Component,
-    T::Properties: ModalLink<T>,
-{
-    pub child: Option<VChild<T>>,
-}
-
-#[derive(Debug)]
-pub enum ModalMsg<T>
-where
-    T: Component,
-{
-    SetPos {
-        top: f64,
-        left: f64,
-        visible: bool,
-        rev_vert: bool,
-    },
-    SubMsg(T::Message),
-}
-
-#[derive(Default)]
-pub struct Modal<T> {
-    css: String,
-    rev_vert: ModalOrientation,
-    _comp: PhantomData<T>,
-}
-
-impl<T> Component for Modal<T>
-where
-    T: Component,
-    T::Properties: ModalLink<T>,
-{
-    type Message = ModalMsg<T>;
-    type Properties = ModalProps<T>;
-
-    fn create(_ctx: &Context<Self>) -> Self {
-        Self {
-            css: ":host{{top:0px;left:0px;opacity:0}}".to_owned(),
-            rev_vert: Default::default(),
-            _comp: PhantomData,
-        }
-    }
-
-    fn update(&mut self, ctx: &Context<Self>, msg: ModalMsg<T>) -> bool {
-        match msg {
-            ModalMsg::SetPos {
-                top,
-                left,
-                visible,
-                rev_vert,
-            } => {
-                let opacity = if visible { "" } else { ";opacity:0" };
-                self.css = format!(":host{{top:{top}px;left:{left}px{opacity}}}");
-                self.rev_vert.set(rev_vert);
-                true
-            },
-            ModalMsg::SubMsg(msg) => {
-                if let Some(child) = &ctx.props().child
-                    && let Some(link) = child.props.weak_link().borrow().as_ref()
-                {
-                    link.send_message(msg);
-                }
-
-                false
-            },
-        }
-    }
-
-    fn view(&self, ctx: &Context<Self>) -> Html {
-        let child = ctx
-            .props()
-            .child
-            .clone()
-            .map(Html::from)
-            .unwrap_or_default();
-
-        html! {
-            <>
-                <style>{ self.css.to_owned() }</style>
-                <ContextProvider<ModalOrientation> context={&self.rev_vert}>
-                    <NoRender>{ child }</NoRender>
-                </ContextProvider<ModalOrientation>>
-            </>
-        }
-    }
-}
-
-#[derive(Clone, Default, Eq, PartialEq)]
-pub struct ModalOrientation(Rc<Cell<bool>>);
-
-impl ImplicitClone for ModalOrientation {}
-
-impl ModalOrientation {
-    pub fn set(&self, value: bool) {
-        self.0.set(value);
-    }
-}
-
-impl From<ModalOrientation> for bool {
-    fn from(x: ModalOrientation) -> Self {
-        x.0.get()
-    }
-}
-
-pub trait ModalLink<T>
-where
-    T: Component,
-{
-    fn weak_link(&self) -> &'_ WeakScope<T>;
-}
-
-pub trait SetModalLink {
-    fn set_modal_link(&self);
-}
-
-impl<T> SetModalLink for &Context<T>
-where
-    T: Component,
-    T::Properties: ModalLink<T>,
-{
-    fn set_modal_link(&self) {
-        *self.props().weak_link().borrow_mut() = Some(self.link().clone());
-    }
-}
-
-#[derive(Properties, Clone)]
-struct NoRenderProps {
-    pub children: Children,
-}
-
-impl PartialEq for NoRenderProps {
-    fn eq(&self, _other: &Self) -> bool {
-        true
-    }
-}
-
-struct NoRender {}
-
-impl Component for NoRender {
-    type Message = ();
-    type Properties = NoRenderProps;
-
-    fn create(_ctx: &Context<Self>) -> Self {
-        Self {}
-    }
-
-    fn view(&self, ctx: &Context<Self>) -> Html {
-        html! { { ctx.props().children.iter().collect::<Html>() } }
-    }
-}

package/src/rust/components/string_column_style.rs

@@ -1,121 +0,0 @@
-// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
-// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
-// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
-// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
-// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
-// ┃ 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). ┃
-// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-
-use yew::prelude::*;
-
-use super::modal::{ModalLink, SetModalLink};
-use crate::components::form::select_enum_field::SelectEnumField;
-use crate::config::*;
-use crate::utils::WeakScope;
-
-/// Format-only widget for [`String`] columns. Renders the `format` enum
-/// only; color/color-mode UI is provided externally as primitive `Enum`
-/// + `Color` schema fields.
-#[derive(Properties)]
-pub struct StringColumnStyleProps {
-    pub config: Option<StringColumnStyleConfig>,
-
-    #[prop_or_default]
-    pub on_change: Callback<ColumnConfigFieldUpdate>,
-
-    #[prop_or_default]
-    pub keys: Vec<String>,
-
-    #[prop_or_default]
-    weak_link: WeakScope<StringColumnStyle>,
-}
-
-impl ModalLink<StringColumnStyle> for StringColumnStyleProps {
-    fn weak_link(&self) -> &'_ WeakScope<StringColumnStyle> {
-        &self.weak_link
-    }
-}
-
-impl PartialEq for StringColumnStyleProps {
-    fn eq(&self, other: &Self) -> bool {
-        self.config == other.config
-    }
-}
-
-pub enum StringColumnStyleMsg {
-    FormatChanged(Option<FormatMode>),
-}
-
-pub struct StringColumnStyle {
-    config: StringColumnStyleConfig,
-}
-
-impl Component for StringColumnStyle {
-    type Message = StringColumnStyleMsg;
-    type Properties = StringColumnStyleProps;
-
-    fn create(ctx: &Context<Self>) -> Self {
-        ctx.set_modal_link();
-        Self {
-            config: ctx.props().config.clone().unwrap_or_default(),
-        }
-    }
-
-    fn changed(&mut self, ctx: &Context<Self>, _old: &Self::Properties) -> bool {
-        let mut new_config = ctx.props().config.clone().unwrap_or_default();
-        if self.config != new_config {
-            std::mem::swap(&mut self.config, &mut new_config);
-            true
-        } else {
-            false
-        }
-    }
-
-    fn update(&mut self, ctx: &Context<Self>, msg: Self::Message) -> bool {
-        match msg {
-            StringColumnStyleMsg::FormatChanged(val) => {
-                self.config.format = val.unwrap_or_default();
-                self.dispatch_config(ctx);
-                true
-            },
-        }
-    }
-
-    fn view(&self, ctx: &Context<Self>) -> Html {
-        let format_mode_changed = ctx.link().callback(StringColumnStyleMsg::FormatChanged);
-        html! {
-            <>
-                <div id="column-style-container" class="string-column-style-container">
-                    <SelectEnumField<FormatMode>
-                        label="format"
-                        on_change={format_mode_changed}
-                        current_value={self.config.format}
-                    />
-                </div>
-            </>
-        }
-    }
-}
-
-impl StringColumnStyle {
-    /// When this config has changed, we must signal the wrapper element.
-    fn dispatch_config(&self, ctx: &Context<Self>) {
-        let value = if self.config == StringColumnStyleConfig::default() {
-            serde_json::Map::new()
-        } else {
-            match serde_json::to_value(&self.config) {
-                Ok(serde_json::Value::Object(m)) => m,
-                _ => serde_json::Map::new(),
-            }
-        };
-
-        ctx.props().on_change.emit(ColumnConfigFieldUpdate {
-            keys: ctx.props().keys.clone(),
-            value,
-        });
-    }
-}