@perspective-dev/workspace 4.0.0

package/dist/css/pro-dark.css

@@ -0,0 +1 @@
+perspective-workspace,perspective-workspace[theme="Pro Dark"],perspective-indicator[theme="Pro Dark"]{--theme-name:"Pro Dark";}perspective-workspace perspective-viewer{--status-bar--height:39px;}perspective-workspace perspective-viewer[settings]{--modal-panel--margin:-4px 0 -4px 0;--status-bar--border-radius:6px 0 0 0;--main-column--margin:3px 0 3px 3px;--main-column--border:1px solid var(--inactive--color);--main-column--border-width:1px 0px 1px 1px;--main-column--border-radius:6px 0 0 6px;--settings-button--margin:10px 0 0 0;}perspective-workspace{font-family:"ui-monospace","SFMono-Regular","SF Mono","Menlo","Consolas","Liberation Mono",monospace;--open-settings-button--content:"expand_more";--close-settings-button--content:"expand_less";--close-button--content:"\2715";--master-divider--background-color:#243136;--menu-maximize--content:"fullscreen";--menu-minimize--content:"fullscreen_exit";--menu-duplicate--content:"call_split";--menu-master--content:"cast";--menu-detail--content:"notes";--menu-export--content:"file_download";--menu-copy--content:"file_copy";--menu-reset--content:"autorenew";--menu-link--content:"link";--menu-unlink--content:"link_off";--menu-newmenu--content:"add";--menu-close--content:"close";--menu-new--content:"description";--menu-newview--content:"file_copy";--workspace-tabbar--border:1px solid var(--inactive--color);--workspace-tabbar--border-width:0px 1px 1px 1px;--workspace-tabbar--border-radius:6px;--workspace-tabbar--border-color:var(--inactive--color);--workspace-tabbar-tab--border-width:1px 1px 0px 1px;--column-drag-handle--mask-image:url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNSIgaGVpZ2h0PSIxMiIgdmlld0JveD0iMCAwIDUgMTIiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSIxMS4wMDAxIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjExLjAwMDEiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSI3LjY2NjgzIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjcuNjY2ODMiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSI0LjMzMzMzIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjQuMzMzMzMiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSIxLjAwMDA4IiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjEuMDAwMDgiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+Cjwvc3ZnPgo=");--bookmarks--mask-image:url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMTEiIHZpZXdCb3g9IjAgMCAyNCAxMSIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICAgIDxwYXRoIGQ9Ik0zLjY2MjE0IDYuOTY0NzZMMC41IDkuODYzMzhWMC41SDcuNVY5Ljg2MzM4TDQuMzM3ODYgNi45NjQ3Nkw0IDYuNjU1MDVMMy42NjIxNCA2Ljk2NDc2WiIgc3Ryb2tlPSIjMDQyMTIxIi8+CiAgICA8cGF0aCBkPSJNMTkgNEwyMSA2TDIzIDQiIHN0cm9rZT0iIzA0MjEyMSIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIi8+Cjwvc3ZnPgo=");background-color:#242526;--workspace-split-panel-handle--background-color:#242526;color:white;--icon--color:white;--active--color:#2770a9;--error--color:#ff9485;--inactive--color:#61656e;--inactive--border-color:#4c505b;--plugin--background:#242526;--modal-target--background:rgba(255,255,255,0.05);--active--background:rgba(39,113,170,0.5);--expression--operator-color:#c5c9d0;--expression--function-color:#22a0ce;--expression--error-color:rgb(255,136,136);--calendar--filter:invert(1);--warning--color:#242526;--warning--background:var(--icon--color);--select-arrow--background-image:var(--select-arrow-light--background-image);--select-arrow--hover--background-image:var(--select-arrow-dark--background-image);--code-editor-symbol--color:white;--code-editor-literal--color:#7dc3f0;--code-editor-operator--color:rgb(23,166,123);--code-editor-comment--color:rgb(204,120,48);--code-editor-column--color:#e18ee1;background-color:#000202;color:white;--workspace-tabbar--background-color:#242526;--workspace-secondary--color:#c5c9d0;--workspace-tabbar--border:1px solid var(--inactive--color);--workspace-tabbar--border-width:0px 1px 1px 1px;--workspace-tabbar--border-radius:6px;--workspace-tabbar--border-color:var(--inactive--color);--workspace-tabbar-tab--border-width:1px 1px 0 1px;}perspective-viewer.workspace-master-widget[theme="Pro Dark"]{--plugin--background:#242526;}perspective-workspace-menu{font-family:"ui-monospace","SFMono-Regular","SF Mono","Menlo","Consolas","Liberation Mono",monospace;font-weight:300;background:#2a2c2f!important;color:white!important;border:1px solid#3b3f46!important;}

package/dist/css/pro.css

@@ -0,0 +1 @@
+perspective-workspace,perspective-workspace[theme="Pro Light"],perspective-indicator[theme="Pro Light"]{--theme-name:"Pro Light";}perspective-workspace{font-family:"ui-monospace","SFMono-Regular","SF Mono","Menlo","Consolas","Liberation Mono",monospace;--open-settings-button--content:"expand_more";--close-settings-button--content:"expand_less";--close-button--content:"\2715";--master-divider--background-color:#243136;--menu-maximize--content:"fullscreen";--menu-minimize--content:"fullscreen_exit";--menu-duplicate--content:"call_split";--menu-master--content:"cast";--menu-detail--content:"notes";--menu-export--content:"file_download";--menu-copy--content:"file_copy";--menu-reset--content:"autorenew";--menu-link--content:"link";--menu-unlink--content:"link_off";--menu-newmenu--content:"add";--menu-close--content:"close";--menu-new--content:"description";--menu-newview--content:"file_copy";--workspace-split-panel-handle--background-color:#f2f4f6;--workspace-tabbar--border:1px solid var(--inactive--color);--workspace-tabbar--border-width:0px 1px 1px 1px;--workspace-tabbar--border-radius:6px;--workspace-tabbar--border-color:var(--inactive--color);--workspace-tabbar-tab--border-width:1px 1px 0px 1px;--column-drag-handle--mask-image:url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNSIgaGVpZ2h0PSIxMiIgdmlld0JveD0iMCAwIDUgMTIiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSIxMS4wMDAxIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjExLjAwMDEiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSI3LjY2NjgzIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjcuNjY2ODMiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSI0LjMzMzMzIiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjQuMzMzMzMiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+CjxjaXJjbGUgY3g9IjMuNDk5OTYiIGN5PSIxLjAwMDA4IiByPSIwLjgzMzMzMyIgZmlsbD0iIzZFNkU2RSIvPgo8Y2lyY2xlIGN4PSIwLjgzMzMzMyIgY3k9IjEuMDAwMDgiIHI9IjAuODMzMzMzIiBmaWxsPSIjNkU2RTZFIi8+Cjwvc3ZnPgo=");--bookmarks--mask-image:url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMTEiIHZpZXdCb3g9IjAgMCAyNCAxMSIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICAgIDxwYXRoIGQ9Ik0zLjY2MjE0IDYuOTY0NzZMMC41IDkuODYzMzhWMC41SDcuNVY5Ljg2MzM4TDQuMzM3ODYgNi45NjQ3Nkw0IDYuNjU1MDVMMy42NjIxNCA2Ljk2NDc2WiIgc3Ryb2tlPSIjMDQyMTIxIi8+CiAgICA8cGF0aCBkPSJNMTkgNEwyMSA2TDIzIDQiIHN0cm9rZT0iIzA0MjEyMSIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIi8+Cjwvc3ZnPgo=");color:#161616;background-color:transparent;--icon--color:#161616;--inactive--color:#ababab;--inactive--border-color:#dadada;--root--background:#ffffff;--active--color:#2670a9;--error--color:#ff471e;--plugin--background:#ffffff;--overflow-hint-icon--color:rgba(0,0,0,0.2);--select--background-color:none;--column-drop-container--background:none;--warning--background:#042121;--warning--color:#fdfffd;--select-arrow--background-image:var(--select-arrow-dark--background-image);--select-arrow--hover--background-image:var(--select-arrow-light--background-image);--overflow-hint-icon--color:#fdfffd;background-color:#dadada;}perspective-workspace perspective-viewer[settings]{--modal-panel--margin:-4px 0 -4px 0;--status-bar--border-radius:6px 0 0 0;--main-column--margin:3px 0 3px 3px;--main-column--border:1px solid var(--inactive--color);--main-column--border-width:1px 0px 1px 1px;--main-column--border-radius:6px 0 0 6px;--settings-button--margin:10px 0 0 0;}perspective-workspace perspective-viewer{--status-bar--height:39px;}perspective-viewer.workspace-master-widget[theme="Pro Light"]{background-color:#f2f4f6;--plugin--background:#f2f4f6;}perspective-viewer.workspace-master-widget[theme="Pro Light"] regular-table td,perspective-viewer.workspace-master-widget[theme="Pro Light"] regular-table th{border-color:#e0e4e9;}perspective-workspace-menu{font-family:"ui-monospace","SFMono-Regular","SF Mono","Menlo","Consolas","Liberation Mono",monospace;font-weight:300;color:#161616;}

package/dist/esm/perspective-workspace.d.ts

@@ -0,0 +1,181 @@
+import type * as psp from "@perspective-dev/client";
+export { PerspectiveWorkspace } from "./workspace";
+export { PerspectiveViewerWidget } from "./workspace/widget";
+import "./external";
+import { PerspectiveWorkspaceConfig, ViewerConfigUpdateExt } from "./workspace";
+/**
+ * A Custom Element for coordinating a set of `<perspective-viewer>` light DOM
+ * children.  `<perspective-workspace>` is built on Lumino.js to allow a more
+ * app-like experience than `<perspective-viewer>`, providing
+ * these features additionally:
+ *
+ * - Docking, arranging, tabbing and max/min-ing of `<perspective-viewer>`s.
+ * - Trivial `<perspective-viewer>` duplication.
+ * - Global Filter sidebar, for using selection state of a pivot table to filter
+ *   siblings.
+ * - Total persistence/serializable state and child state.
+ * - Easy sharing/ownership of `Table()` among different `<perspective-viewer>`.
+ * - A cool DOM-reactive API.
+ *
+ * There are a few ways to use this Custom Element.  In plain HTML, you can
+ * express your initial view simply:
+ *
+ * ```html
+ * <perspective-workspace>
+ *     <perspective-viewer
+ *         name="View One"
+ *         table="superstore">
+ *     </perspective-viewer>
+ *     <perspective-viewer
+ *         name="View Two"
+ *         table="superstore">
+ *     </perspective-viewer>
+ * </perspective-workspace>
+ * ```
+ *
+ * You can also use the DOM API in Javascript:
+ *
+ * ```javascript
+ * const workspace = document.createElement("perspective-workspace");
+ * const viewer = document.createElement("perspective-viewer");
+ * workspace.appendChild(viewer);
+ * document.body.appendChild(workspace);
+ * ```
+ *
+ * This will yield a `<perspective-workspace> with the default layout.  To load
+ * a `Table()`, add it to `tables` via the `Map()` API where it will be
+ * auto-wired into all matching `<perspective-viewer>`s immediately:
+ *
+ * ```javascript
+ * workspace.tables.set("superstore", await worker.table(my_data));
+ * ```
+ *
+ *
+ */
+export declare class HTMLPerspectiveWorkspaceElement extends HTMLElement {
+    private workspace?;
+    private _resize_observer?;
+    constructor();
+    /***************************************************************************
+     *
+     * Public
+     *
+     */
+    /**
+     * Persists this `<perspective-workspace>` to a token `Object`.  This object
+     * is JSON serializable and describes the state of the Workspace and it's
+     * child `<perspective-viewer>` elements.  Some important keys:
+     *
+     * - `viewers`: The serialized state of `<perspective-viewer>` children,
+     *   named by `slot`.
+     * - `detail`: The main layout.
+     * - `master`: The contents of the Global Filter sidebar.
+     *
+     * While the `table` attribute is persisted for each `perspective-viewer`,
+     * `Table`s themselves must be added to the `tables` property `Map()`
+     * separately.
+     *
+     * @return {Object} A configuration token, compatible with
+     * `restore(config)`.
+     * @example
+     * // Save this layout to local storage
+     * const workspace = document.querySelector("perspective-workspace");
+     * localStorage.set("CONFIG", JSON.stringify(workspace.save()));
+     */
+    save(): Promise<{
+        viewers: Record<string, import("@perspective-dev/viewer").ViewerConfigUpdate>;
+        sizes: number[];
+        detail: import("@lumino/widgets").DockLayout.ILayoutConfig | undefined;
+        master: {
+            widgets: string[];
+            sizes: number[];
+        } | undefined;
+    }>;
+    /**
+     * Restore this `<perspective-workspace>` to a previous state captured by
+     * `save()`.  Calling this method will completely rewrite this element's
+     * `innerHTML`, but may reuse `<perspective-viewer>`  children depending
+     * on the `slot` attribute names.  However, it should always be possible
+     * to recreate any given state from within the UI itself, as the attributes
+     * on `<perspective-viewer>` itself create immutable views.
+     *
+     * While the `table` attribute is set for each `perspective-viewer`,
+     * `Table`s themselves must be added to the `tables` property `Map()`
+     * separately.
+     * @param {Object} config A configuration token, as returned by `save()`.
+     * @example
+     * // Restore this layout from local storage
+     * const workspace = document.querySelector("perspective-workspace");
+     * workspace.restore(JSON.parse(localStorage.get("CONFIG"));
+     *
+     * // Add `Table` separately.
+     * workspace.tables.set("superstore", await worker.table(data));
+     */
+    restore(layout: PerspectiveWorkspaceConfig<string>): Promise<void>;
+    clear(): Promise<void>;
+    /**
+     * Await all asynchronous tasks for all viewers in this workspace. This is
+     * useful to make sure asynchonous side effects of synchronous methods calls
+     * are applied.
+     */
+    flush(): Promise<void>;
+    /**
+     * Add a new viewer to the workspace for a given `ViewerConfigUpdateExt`.
+     * @param config
+     */
+    addViewer(config: ViewerConfigUpdateExt): Promise<void>;
+    /**
+     * Add a new `Table` to the workspace, so that it can be bound by viewers.
+     * Each `Table` is identified by a unique `name`.
+     */
+    addTable(name: string, table: Promise<psp.Table>): Promise<void>;
+    /**
+     * Deleta a table by name from this workspace
+     * @param name
+     * @returns
+     */
+    getTable(name: string): psp.Table | Promise<psp.Table>;
+    /**
+     * Replace a `Table` by name. As `Table` doe snot guarantee the same
+     * structure, this will wipe the viewer's state.
+     * @param name
+     * @param table
+     */
+    replaceTable(name: string, table: Promise<psp.Table>): Promise<void>;
+    /**
+     * Remove a `Table` by name.
+     * @param name
+     * @returns
+     */
+    removeTable(name: string): boolean;
+    /**
+     * A `Map()` of `perspective.Table()` by name.  The names set here will auto
+     * wire any child `perspective-viewer` elements in this Workspace's subtree,
+     * by looking up their respective `table` attribute.
+     *
+     * Calling methods on this `Map()` may have side-effects, as
+     * `PerspectiveViewerHTMLElement.load()` is called when a new `Table()` is
+     * set with a name matching an existing child `perspective-viewer`.
+     *
+     * @readonly
+     * @memberof HTMLPerspectiveWorkspaceElement
+     */
+    get tables(): import("./utils/observable_map").ObservableMap<string, psp.Table | Promise<psp.Table>>;
+    /**
+     * Invalidate this component's dimensions and recalculate.
+     */
+    resize(): Promise<void>;
+    /**
+     * Set whether this workspace element should auto-size itself via a
+     * `ResizeObserver`.
+     */
+    setAutoSize(is_auto_size: boolean): void;
+    connectedCallback(): void;
+    /***************************************************************************
+     *
+     * Private
+     *
+     */
+    private _light_dom_changed;
+    private _register_light_dom_listener;
+}