@peter.prib/renderengine 0.8.0 → 0.9.0

package/src/charting/table/TableViewChart.js

@@ -0,0 +1,126 @@
+import { TableChart } from '../charts/TableChart.js';
+import { ChartBox, ChartLabels } from '../ChartBox.js';
+import { PopupMenu } from '../PopupMenu.js';
+
+/**
+ * TableViewChart — the interactive table: a TableChart drawn from a TableView's state, whose parts
+ * answer clicks. A header sorts (and its ▾ opens the column's menu); a cell opens the cell's menu; a
+ * row number opens the row's menu; the corner ⋮ opens the table's menu (with "Show as" when the host
+ * can draw a chart); the footer's ‹ › page. Each change goes through the view, whose `onChange`
+ * redraws.
+ *
+ * Interaction needs a renderer whose shapes are DOM elements (SVG: `supportsSceneGraph`); anywhere
+ * else it draws the same table without the clicks.
+ */
+export class TableViewChart extends TableChart {
+    static GUTTER_W = 44;
+    static MENU_GLYPH = '▾';
+    static TABLE_GLYPH = '⋮';
+
+    /**
+     * @param renderer
+     * @param {TableView} view
+     * @param {object} [options] title, nullText; onShowAs(choice) — draws a chart for the table menu's
+     *   "Show as"; showMenu(x, y, items) — opens a menu (PopupMenu.show by default)
+     */
+    constructor(renderer, view, options = {}) {
+        super(renderer, view.rows, options);
+        this.view = view;
+        this.showMenu = options.showMenu ?? ((x, y, items) => PopupMenu.show(x, y, items));
+    }
+
+    /** The height this draws: title, header, the page's rows and the footer. */
+    static heightFor(view, { title } = {}) {
+        const { top, bottom } = TableChart.margins(title);
+        return top + (2 + view.pageRows().length) * TableChart.ROW_H + bottom;
+    }
+
+    _render() {
+        const { view } = this;
+        const { title, nullText = '—' } = this.options;
+        const { ROW_H, PAD_X } = TableChart;
+        const box = ChartBox.fromRenderer(this.renderer, TableChart.margins(title));
+        const interactive = this.renderer.supportsSceneGraph === true;
+        const columns = view.visibleColumns().map(c => ({ key: c.name, label: c.name, align: c.kind === 'numeric' ? 'end' : 'start' }));
+        const gutter = TableViewChart.GUTTER_W;
+        const colW = columns.length > 0 ? (box.width - gutter) / columns.length : box.width - gutter;
+        const x0 = box.x + gutter;
+
+        new ChartLabels({ title }).draw(this.renderer, { x: box.x, y: box.y, width: box.width, height: box.height });
+
+        // Header: the corner (table menu), then a header per column (sort; ▾ column menu).
+        let top = box.y;
+        this.renderer.rect(box.x, top, box.width, ROW_H, TableChart.HEADER_FILL, null);
+        const corner = this.renderer.rect(box.x, top, gutter, ROW_H, TableChart.HEADER_FILL, null);
+        const cornerGlyph = this._text(TableViewChart.TABLE_GLYPH, box.x + gutter / 2, top, { textAnchor: 'middle', fontWeight: 'bold', fill: '#555' });
+        this._on(interactive, [corner, cornerGlyph], (e) => this.showMenu(e.clientX, e.clientY, view.tableMenu(this.options.onShowAs ?? null)), 'Table menu');
+
+        columns.forEach((c, i) => {
+            const left = x0 + i * colW;
+            const sorted = view.sort?.column === c.key ? (view.sort.direction === 'asc' ? ' ▲' : ' ▼') : '';
+            // In words: an arrow-like mark here read as a second sort arrow.
+            const filtered = view.filters.some(f => f.column === c.key) ? ' (filtered)' : '';
+            const head = this.renderer.rect(left, top, colW, ROW_H, TableChart.HEADER_FILL, null);
+            // The label leaves room at the right for the ▾.
+            const label = this._cell(`${c.label}${sorted}${filtered}`, c, left, top, colW - 16, { fontWeight: 'bold', fill: '#333' });
+            this._on(interactive, [head, label], () => view.toggleSort(c.key), 'Sort');
+            const glyph = this._text(TableViewChart.MENU_GLYPH, left + colW - 8, top, { textAnchor: 'middle', fill: '#777' });
+            this._on(interactive, [glyph], (e) => this.showMenu(e.clientX, e.clientY, view.columnMenu(c.key)), `${c.label} menu`);
+        });
+        top += ROW_H;
+        this._rule(box.x, top, box.width);
+
+        // Rows: a number in the gutter (row menu), a cell per column (cell menu).
+        view.pageRows().forEach(({ row, index }, r) => {
+            if (r % 2 === 1) this.renderer.rect(box.x, top, box.width, ROW_H, TableChart.STRIPE_FILL, null);
+            const number = this._text(String(index + 1), box.x + gutter - PAD_X, top, { textAnchor: 'end', fill: '#999', fontSize: '11px' });
+            this._on(interactive, [number], (e) => this.showMenu(e.clientX, e.clientY, view.rowMenu(row)), 'Row menu');
+            columns.forEach((c, i) => {
+                const left = x0 + i * colW;
+                const hit = this.renderer.rect(left, top, colW, ROW_H, 'transparent', null);
+                const text = this._cell(TableChart.cellText(row[c.key], nullText), c, left, top, colW, { fill: row[c.key] == null ? '#999' : '#222' });
+                this._on(interactive, [hit, text], (e) => this.showMenu(e.clientX, e.clientY, view.cellMenu(row, c.key)), null);
+            });
+            top += ROW_H;
+            this._rule(box.x, top, box.width);
+        });
+
+        this._footer(box, top, interactive);
+    }
+
+    /** "1–50 of 120 rows (filtered from 300: Region = West)", and ‹ › when there is more than a page. */
+    _footer(box, top, interactive) {
+        const { view } = this;
+        const shown = view.pageRows();
+        const total = view.filtered().length;
+        const range = shown.length === 0 ? 'No rows' : `${shown[0].index + 1}–${shown.at(-1).index + 1} of ${total} row${total === 1 ? '' : 's'}`;
+        const filters = view.filters.length > 0 ? ` (filtered from ${view.rows.length}: ${view.describeFilters()})` : '';
+        this._text(`${range}${filters}`, box.x + TableChart.PAD_X, top, { textAnchor: 'start', fill: '#666', fontSize: '11px' });
+        if (view.pageCount() > 1) {
+            const right = box.x + box.width - TableChart.PAD_X;
+            const previous = this._text('‹ previous', right - 70, top, { textAnchor: 'end', fill: view.page > 0 ? '#2b5fd9' : '#bbb', fontSize: '11px' });
+            const next = this._text('next ›', right, top, { textAnchor: 'end', fill: view.page < view.pageCount() - 1 ? '#2b5fd9' : '#bbb', fontSize: '11px' });
+            this._on(interactive, [previous], () => view.goToPage(view.page - 1), 'Previous page');
+            this._on(interactive, [next], () => view.goToPage(view.page + 1), 'Next page');
+        }
+    }
+
+    _text(text, x, top, attrs) {
+        return this.renderer.text(text, x, top + TableChart.ROW_H / 2, { verticalAlign: 'middle', fontSize: '12px', ...attrs });
+    }
+
+    /** Wires a click to each element that can take one (SVG); a pointer cursor and a tooltip say so. */
+    _on(interactive, elements, handler, title) {
+        if (!interactive) return;
+        for (const el of elements) {
+            if (typeof el?.addEventListener !== 'function') continue;
+            el.addEventListener('click', (event) => { event.stopPropagation?.(); handler(event); });
+            if (el.style) el.style.cursor = 'pointer';
+            if (title && typeof el.setAttribute === 'function' && el.ownerDocument) {
+                const t = el.ownerDocument.createElementNS('http://www.w3.org/2000/svg', 'title');
+                t.textContent = title;
+                el.appendChild(t);
+            }
+        }
+    }
+}

package/src/index.js

@@ -35,6 +35,8 @@ import { SunburstChart } from './charting/charts/SunburstChart.js';
 import { OutlineChart } from './charting/charts/OutlineChart.js';
 import { TableChart } from './charting/charts/TableChart.js';
 import { ChartChooser } from './charting/ChartChooser.js';
+import { TableView } from './charting/table/TableView.js';
+import { TableViewChart } from './charting/table/TableViewChart.js';
 import { RadarChart } from './charting/charts/RadarChart.js';
 import { FunnelChart } from './charting/charts/FunnelChart.js';
 import { WaterfallChart } from './charting/charts/WaterfallChart.js';
@@ -217,7 +219,7 @@ import {
 // separate browser-only entry: import 'renderengine/src/workspace.js' directly.
 
 export {
-  Mat4, OrbitCamera, CHART_CATALOG, getChartCatalogEntry, chartRegistry, ChartChooser, TableChart,
+  Mat4, OrbitCamera, CHART_CATALOG, getChartCatalogEntry, chartRegistry, ChartChooser, TableChart, TableView, TableViewChart,
   DIAGRAM_CATALOG, getDiagramCatalogEntry, diagramRegistry,
   TREE_MODE_CATALOG, treeModeRegistry, getTreeModeCatalogEntry,
   AXIS_KIND, ENCODING_CHANNEL, COORD_SYSTEM, COLOR_MODE, CAMERA_MODE,
@@ -1437,6 +1439,62 @@ export class RenderEngine {
         this._renderChart(new TableChart(this.renderer, data, options));
     }
 
+    /**
+     * Shows result rows as an interactive table — sort, filter, hide columns, page, copy, through
+     * menus on its cells, rows, columns and the table itself — whose table menu can show what it
+     * holds as any chart type ChartChooser says fits ("Show as"); a chart drawn that way has a
+     * "◂ Table" link back to the table as it was left. One output for a result, table or chart.
+     *
+     * The container's height follows what is drawn (the table's rows, or `chartHeight` for a chart),
+     * so the host gives the container a width only. Interaction needs the SVG renderer; on canvas
+     * the table is drawn without it.
+     * @param {Array<object>} rows
+     * @param {object} [options]
+     * @param {Array<{name, kind?, measure?}>} [options.columns] hints (ChartChooser's)
+     * @param {boolean} [options.complete] false when the rows are only part of the answer
+     * @param {number} [options.pageSize] rows per page (50)
+     * @param {object} [options.menus] the host's own items: { cell, row, column, table } → items
+     * @param {string} [options.title]
+     * @param {number} [options.chartHeight] a chart's height (360)
+     * @param {boolean} [options.fitHeight] size the container to what is drawn (true)
+     * @returns {TableView|null} the table's state, for the host to read or change
+     */
+    resultView(rows, options = {}) {
+        if (!this.renderer) return null;
+        const view = new TableView(rows, { ...options, onChange: () => this._drawResultTable(view, options) });
+        this._drawResultTable(view, options);
+        return view;
+    }
+
+    _drawResultTable(view, options) {
+        this._fitResultHeight(TableViewChart.heightFor(view, options), options);
+        this._chart3D = false;
+        this._chartState = { type: 'table', data: view.rows, options };
+        this._renderChart(new TableViewChart(this.renderer, view, {
+            ...options,
+            onShowAs: (choice) => this._drawResultChart(view, choice, options),
+        }));
+    }
+
+    _drawResultChart(view, choice, options) {
+        this._fitResultHeight(options.chartHeight ?? 360, options);
+        this.renderChartType(choice.key, choice.data, { title: options.title ?? choice.reason });
+        // The way back, drawn over the chart: the same table, as it was left.
+        if (!this.renderer.supportsSceneGraph) return;
+        const back = this.renderer.text('◂ Table', 8, 14, { fill: '#2b5fd9', fontSize: '12px', verticalAlign: 'middle' });
+        back?.addEventListener?.('click', () => this._drawResultTable(view, options));
+        if (back?.style) back.style.cursor = 'pointer';
+    }
+
+    _fitResultHeight(height, options) {
+        if (options.fitHeight === false || !this.container?.style) return;
+        // min-height as well: in a flex layout (a notebook, a workbench pane) a height alone is
+        // shrunk to fit, and the table drawn into the shrunk box lost its last rows.
+        this.container.style.height = `${height}px`;
+        this.container.style.minHeight = `${height}px`;
+        this.fitToContainer();
+    }
+
     /**
      * Renders a waterfall chart — running-total bars, each floating from the
      * previous cumulative value to the new one (a "delta" bar), except