@peter.prib/renderengine 0.8.0 → 0.10.0

package/{REFERENCE.md → documentation/REFERENCE.md}

@@ -1112,6 +1112,10 @@ or `'time'` (without a hint, a column whose values are all numbers is numeric, e
 | two categories, one number | `groupedBar`, `heatmap`; with a time column, `line` (a line per category) first |
 | anything else | `table` only |
 
+A chart is of **one value per category**: rows that repeat a category (orders, not totals per
+region) get no chart — group them in the query first — since a bar per row would repeat its label,
+and a repeated pair of categories would replace another's value unseen.
+
 Three rules keep a choice from misleading: only an **additive** measure is offered as shares of a
 whole (a slice of an average or a balance means nothing); only **complete** rows are (three
 customers' slices of a top 3 would claim to be the whole); and a **missing value is never drawn as
@@ -1121,6 +1125,43 @@ only the cells present, still is), and a bar chart simply has no bar for a null.
 A table has no axes, so it takes none of a chart's axis margins. `TableChart.heightFor(rowCount,
 { title?, maxRows? })` is the height it will draw, for sizing its container first.
 
+### One output for a result — `resultView`
+
+`engine.resultView(rows, options)` shows result rows as an **interactive table** whose own menu
+can show them as any chart that fits — table or chart, one output. It returns the table's state, a
+`TableView`.
+
+```javascript
+const view = new RenderEngine(container, { rendererType: 'svg' }).resultView(rows, {
+    columns: [{ name: 'Day', kind: 'time' }, { name: 'Revenue', measure: 'additive' }],  // ChartChooser hints
+    complete: true,    // false when the rows are only part of the answer (a top N)
+    pageSize: 50,
+    menus: { row: ({ row }) => [{ label: 'Open order', action: () => open(row.id) }] },
+    highlight: (row) => row.id === selectedId,   // rows drawn highlighted: the host's selection
+});
+```
+
+| Click | Does |
+|---|---|
+| a column header | sorts: ascending, descending, unsorted (nulls always last; equal values keep their order) |
+| a header's ▾ | the column menu: sort, **Filter to** one of its values (up to 20 listed), clear its filters, hide it, copy it |
+| a cell | the cell menu: only / exclude rows with this value (or with an empty one); for a number, only rows above / below it; copy the value |
+| a row number | the row menu: copy the row (tab-separated, or as JSON) |
+| the corner ⋮ | the table menu: **Show as** (the chart types ChartChooser says fit what is showing), clear all filters, show hidden columns, copy the table |
+| the footer's ‹ › | pages; the footer says "1–50 of 120 rows (filtered from 300: Region = West)" |
+
+Filtering is by choosing values in the table, never by typing. A filter, a sort or a hidden column
+carries into **Show as**: the chart is drawn from the rows and columns showing, in their order, and
+filtered rows are never offered as shares of a whole. A chart drawn that way has a **◂ Table** link
+back to the table as it was left. The container's height follows what is drawn (the table's rows,
+or `chartHeight`, 360); pass `fitHeight: false` to size it yourself. A host adds its own items to
+any menu with `menus: { cell, row, column, table }`, each `(context) → PopupMenu items`, shown after
+a separator.
+
+Interaction needs the SVG renderer (its shapes take clicks); on canvas the same table is drawn
+without it. `TableView` (`src/charting/table/TableView.js`) holds all of the state and builds every
+menu as data, so it can be driven and tested without a DOM; `TableViewChart` draws it.
+
 Every suggestion is checked against the registry the chooser is given (`chartRegistry` by default):
 a type is offered only if the catalog has it and every axis it marks `required` is one the result's
 shape provides, so the catalog stays the single source of truth for what each chart needs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.prib/renderengine",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "ArchiMate modeller, diagram editor and chart library for the browser, with no runtime dependencies.",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "examples/diagram-editor.html",
     "examples/data-model.html",
     "README.md",
-    "REFERENCE.md",
+    "documentation/REFERENCE.md",
     "LICENSE"
   ],
   "scripts": {
@@ -28,7 +28,7 @@
     "archimate": "node scripts/open.mjs examples/archimate.html",
     "diagram": "node scripts/open.mjs examples/diagram-editor.html",
     "datamodel": "node scripts/open.mjs examples/data-model.html",
-    "test": "node --test --test-timeout=10000 ./test/*.js ./test/charting/*.js ./test/charting/charts/*.js ./test/charting/diagrams/*.js ./test/charting/shapes/*.js",
+    "test": "node --test --test-timeout=10000 ./test/*.js ./test/charting/*.js ./test/charting/charts/*.js ./test/charting/table/*.js ./test/charting/diagrams/*.js ./test/charting/shapes/*.js",
     "build": "rollup -c",
     "prepublishOnly": "npm test && npm run build",
     "screenshots": "node scripts/screenshots/screenshots.mjs"

package/src/bian.js

@@ -12,7 +12,7 @@
  * (github.com/bian-official/public, Apache-2.0) for the names control records
  * have and, where a pattern aggregates two creating terms (Monitor: evaluate
  * and initiate), the one its APIs use. Every value is BIAN's; `inferred` is
- * kept for a value that is not. See BIAN_ALIGNMENT.md.
+ * kept for a value that is not. See documentation/BIAN_ALIGNMENT.md.
  */
 
 /** One way a service domain behaves: what it does to its asset, and the record it keeps of it. */

package/src/chartCatalog.js

@@ -1,7 +1,7 @@
 // Copyright 2026 Jaroslav Peter Prib, Purveyor of Excellence
 /**
  * Single source of truth for "what chart types does RenderEngine support" —
- * see ARCHITECTURE.md's "Chart-type catalog" section for the full story.
+ * see documentation/ARCHITECTURE.md's "Chart-type catalog" section for the full story.
  *
  * This is not just a flat {key,label} list. Chart types share real,
  * composable capabilities — every one of them takes a title; several accept

package/src/charting/ChartChooser.js

@@ -104,6 +104,17 @@ class ResultShape {
             numbers: columns.filter(c => c.kind === 'numeric'),
         };
     }
+
+    /**
+     * Whether each row has its own value of the category columns. Rows that repeat a category
+     * (rows of orders, not totals per region) would be drawn as one bar per row with the same
+     * label over and over — or, for two categories, one repeated pair would replace another's value
+     * unseen. A chart of a value per category needs one row per category: a GROUP BY first.
+     */
+    static oneRowEach(rows, categories) {
+        const keys = new Set(rows.map(r => JSON.stringify(categories.map(c => r[c.name] ?? null))));
+        return keys.size === rows.length;
+    }
 }
 
 /** One number and nothing to group it by: a single figure. */
@@ -123,7 +134,8 @@ class SingleFigure extends ResultShape {
 class CategoryValue extends ResultShape {
     static of(columns, rows) {
         const { categories, numbers } = ResultShape.split(columns);
-        return categories.length === 1 && numbers.length === 1 ? new CategoryValue(categories[0], numbers[0], rows) : null;
+        return categories.length === 1 && numbers.length === 1 && ResultShape.oneRowEach(rows, categories)
+            ? new CategoryValue(categories[0], numbers[0], rows) : null;
     }
     constructor(category, number, rows) { super(); this.category = category; this.number = number; this.rows = rows; }
     get provides() { return { category: AXIS_KIND.CATEGORICAL, value: AXIS_KIND.NUMERIC }; }
@@ -163,7 +175,8 @@ CategoryValue.MAX_SLICES = 8;
 class CategorySeries extends ResultShape {
     static of(columns, rows) {
         const { categories, numbers } = ResultShape.split(columns);
-        return categories.length === 1 && numbers.length >= 2 ? new CategorySeries(categories[0], numbers, rows) : null;
+        return categories.length === 1 && numbers.length >= 2 && ResultShape.oneRowEach(rows, categories)
+            ? new CategorySeries(categories[0], numbers, rows) : null;
     }
     constructor(category, numbers, rows) { super(); this.category = category; this.numbers = numbers; this.rows = rows; }
     get provides() { return { category: AXIS_KIND.CATEGORICAL, value: AXIS_KIND.NUMERIC, series: AXIS_KIND.CATEGORICAL }; }
@@ -191,7 +204,8 @@ class CategorySeries extends ResultShape {
 class TwoCategories extends ResultShape {
     static of(columns, rows) {
         const { categories, numbers } = ResultShape.split(columns);
-        return categories.length === 2 && numbers.length === 1 ? new TwoCategories(categories, numbers[0], rows) : null;
+        return categories.length === 2 && numbers.length === 1 && ResultShape.oneRowEach(rows, categories)
+            ? new TwoCategories(categories, numbers[0], rows) : null;
     }
     constructor(categories, number, rows) {
         super();

package/src/charting/PopupMenu.js

@@ -1,150 +1,152 @@
-import { el } from '../workspace/dom.js';
-
-/**
- * PopupMenu — the one popup/context menu: a small menu at a screen position,
- * closed by choosing an item, clicking elsewhere, Escape, or scrolling (it
- * would no longer be beside what it was opened on). One is open at a time.
- * Editor menus, the graph engine's ContextMenu and the model tree's menus all
- * render through it.
- *
- * Items: `{ label, action, danger?, checked?, disabled? }`,
- * `{ label, items: [...] }` for a submenu, or `{ separator: true }`.
- */
-export class PopupMenu {
-    static _open = null;
-
-    static show(x, y, items, doc = document) {
-        PopupMenu.close();
-        if (!items.length) return null;
-        const menu = el({
-            ...PopupMenu._panel(items, doc),
-            style: { ...PopupMenu._panelStyle, position: 'fixed', left: `${x}px`, top: `${y}px` },
-        }, doc);
-        doc.body.appendChild(menu);
-        // Opened near the window's right or bottom edge, it moves back into the window.
-        const win = doc.defaultView;
-        const box = menu.getBoundingClientRect?.();
-        if (win && box?.width) {
-            const at = PopupMenu.fit(x, y, box.width, box.height, win.innerWidth, win.innerHeight);
-            Object.assign(menu.style, { left: `${at.x}px`, top: `${at.y}px` });
-        }
-        // Registered after the opening click has finished propagating.
-        const dismiss = () => PopupMenu.close();
-        const onKey = (e) => { if (e.key === 'Escape') PopupMenu.close(); };
-        setTimeout(() => {
-            if (PopupMenu._open?.menu !== menu) return;   // closed meanwhile
-            doc.addEventListener('click', dismiss, { once: true });
-            doc.addEventListener('scroll', dismiss, { once: true, capture: true });
-            doc.addEventListener('keydown', onKey);
-        }, 0);
-        PopupMenu._open = { menu, dismiss, onKey, doc };
-        return menu;
-    }
-
-    /**
-     * Where a menu of a size goes, asked for at (x, y), to be all inside a
-     * window of a size: left of the point when it would pass the right edge,
-     * above it when it would pass the bottom, never past the top-left.
-     */
-    static fit(x, y, width, height, windowWidth, windowHeight, margin = 4) {
-        const left = x + width + margin > windowWidth ? x - width : x;
-        const top = y + height + margin > windowHeight ? y - height : y;
-        return {
-            x: Math.max(margin, Math.min(left, windowWidth - width - margin)),
-            y: Math.max(margin, Math.min(top, windowHeight - height - margin)),
-        };
-    }
-
-    /**
-     * Where a submenu opens beside its item (the item's box `{left, right, top}`),
-     * to be all inside the window: to the right, or to the left when the right
-     * would pass the edge (and there is more room on the left); level with the
-     * item, or lifted by as much as it would pass the bottom. `top` is relative
-     * to the item, as the submenu is positioned.
-     */
-    static submenuPlacement(item, width, height, windowWidth, windowHeight, margin = 4) {
-        const fitsRight = item.right + width + margin <= windowWidth;
-        const side = fitsRight || item.left < windowWidth - item.right ? 'right' : 'left';
-        const top = -4;
-        const overflow = item.top + top + height + margin - windowHeight;
-        return { side, top: overflow > 0 ? Math.max(top - overflow, margin - item.top) : top };
-    }
-
-    static close() {
-        const open = PopupMenu._open;
-        if (!open) return;
-        open.menu.remove();
-        open.doc.removeEventListener('click', open.dismiss);
-        open.doc.removeEventListener('scroll', open.dismiss, { capture: true });
-        open.doc.removeEventListener('keydown', open.onKey);
-        PopupMenu._open = null;
-    }
-
-    static get isOpen() {
-        return !!PopupMenu._open;
-    }
-
-    static _panelStyle = {
-        background: '#fff', border: '1px solid #ccc', borderRadius: '3px', boxShadow: '0 2px 8px rgba(0,0,0,0.2)',
-        zIndex: '10000', minWidth: '170px', fontSize: '12px', fontFamily: 'sans-serif', padding: '4px 0',
-    };
-
-    static _panel(items, doc) {
-        return { attrs: { role: 'menu' }, children: items.map(item => PopupMenu._item(item, doc)) };
-    }
-
-    static _item(item, doc) {
-        if (item.separator) return { attrs: { role: 'separator' }, style: { borderTop: '1px solid #ddd', margin: '4px 0' } };
-        const hover = item.danger ? '#ffe8e8' : '#f0f0f0';
-        const base = {
-            attrs: { role: 'menuitem', 'aria-disabled': item.disabled ? 'true' : null, 'aria-checked': item.checked != null ? String(!!item.checked) : null },
-            style: {
-                padding: '7px 14px', cursor: item.disabled ? 'default' : 'pointer', position: 'relative', whiteSpace: 'nowrap',
-                color: item.disabled ? '#aaa' : item.danger ? '#cc3333' : '', background: item.checked ? '#e3f2fd' : '',
-            },
-        };
-        if (item.items) {
-            let sub;
-            return {
-                ...base,
-                attrs: { ...base.attrs, 'aria-haspopup': 'menu' },
-                on: {
-                    mouseenter: (e) => {
-                        e.currentTarget.style.background = hover;
-                        sub.style.display = 'block';
-                        // Opened near the window's right or bottom edge, it opens left, or lifts.
-                        const win = e.currentTarget.ownerDocument.defaultView;
-                        const box = sub.getBoundingClientRect?.();
-                        if (!win || !box?.width) return;
-                        const at = PopupMenu.submenuPlacement(e.currentTarget.getBoundingClientRect(), box.width, box.height, win.innerWidth, win.innerHeight);
-                        Object.assign(sub.style, at.side === 'left' ? { left: 'auto', right: '100%' } : { left: '100%', right: 'auto' }, { top: `${at.top}px` });
-                    },
-                    mouseleave: (e) => { e.currentTarget.style.background = ''; sub.style.display = 'none'; },
-                    click: (e) => e.stopPropagation(),
-                },
-                children: [
-                    `${item.label} ▸`,
-                    {
-                        ...PopupMenu._panel(item.items, doc),
-                        style: { ...PopupMenu._panelStyle, position: 'absolute', left: '100%', top: '-4px', display: 'none' },
-                        ref: (n) => { sub = n; },
-                    },
-                ],
-            };
-        }
-        return {
-            ...base,
-            text: item.label,
-            on: {
-                mouseenter: (e) => { if (!item.disabled) e.currentTarget.style.background = hover; },
-                mouseleave: (e) => { e.currentTarget.style.background = item.checked ? '#e3f2fd' : ''; },
-                click: (e) => {
-                    e.stopPropagation();
-                    if (item.disabled) return;
-                    PopupMenu.close();
-                    item.action();
-                },
-            },
-        };
-    }
-}
+import { el } from '../workspace/dom.js';
+
+/**
+ * PopupMenu — the one popup/context menu: a small menu at a screen position,
+ * closed by choosing an item, clicking elsewhere, Escape, or scrolling (it
+ * would no longer be beside what it was opened on). One is open at a time.
+ * Editor menus, the graph engine's ContextMenu and the model tree's menus all
+ * render through it.
+ *
+ * Items: `{ label, action, danger?, checked?, disabled? }`,
+ * `{ label, items: [...] }` for a submenu, or `{ separator: true }`.
+ */
+export class PopupMenu {
+    static _open = null;
+
+    static show(x, y, items, doc = document) {
+        PopupMenu.close();
+        if (!items.length) return null;
+        const menu = el({
+            ...PopupMenu._panel(items, doc),
+            style: { ...PopupMenu._panelStyle, position: 'fixed', left: `${x}px`, top: `${y}px` },
+        }, doc);
+        doc.body.appendChild(menu);
+        // Opened near the window's right or bottom edge, it moves back into the window.
+        const win = doc.defaultView;
+        const box = menu.getBoundingClientRect?.();
+        if (win && box?.width) {
+            const at = PopupMenu.fit(x, y, box.width, box.height, win.innerWidth, win.innerHeight);
+            Object.assign(menu.style, { left: `${at.x}px`, top: `${at.y}px` });
+        }
+        // Registered after the opening click has finished propagating.
+        const dismiss = () => PopupMenu.close();
+        const onKey = (e) => { if (e.key === 'Escape') PopupMenu.close(); };
+        setTimeout(() => {
+            if (PopupMenu._open?.menu !== menu) return;   // closed meanwhile
+            doc.addEventListener('click', dismiss, { once: true });
+            doc.addEventListener('scroll', dismiss, { once: true, capture: true });
+            doc.addEventListener('keydown', onKey);
+        }, 0);
+        PopupMenu._open = { menu, dismiss, onKey, doc };
+        return menu;
+    }
+
+    /**
+     * Where a menu of a size goes, asked for at (x, y), to be all inside a
+     * window of a size: left of the point when it would pass the right edge,
+     * above it when it would pass the bottom, never past the top-left.
+     */
+    static fit(x, y, width, height, windowWidth, windowHeight, margin = 4) {
+        const left = x + width + margin > windowWidth ? x - width : x;
+        const top = y + height + margin > windowHeight ? y - height : y;
+        return {
+            x: Math.max(margin, Math.min(left, windowWidth - width - margin)),
+            y: Math.max(margin, Math.min(top, windowHeight - height - margin)),
+        };
+    }
+
+    /**
+     * Where a submenu opens beside its item (the item's box `{left, right, top}`),
+     * to be all inside the window: to the right, or to the left when the right
+     * would pass the edge (and there is more room on the left); level with the
+     * item, or lifted by as much as it would pass the bottom. `top` is relative
+     * to the item, as the submenu is positioned.
+     */
+    static submenuPlacement(item, width, height, windowWidth, windowHeight, margin = 4) {
+        const fitsRight = item.right + width + margin <= windowWidth;
+        const side = fitsRight || item.left < windowWidth - item.right ? 'right' : 'left';
+        const top = -4;
+        const overflow = item.top + top + height + margin - windowHeight;
+        return { side, top: overflow > 0 ? Math.max(top - overflow, margin - item.top) : top };
+    }
+
+    static close() {
+        const open = PopupMenu._open;
+        if (!open) return;
+        open.menu.remove();
+        open.doc.removeEventListener('click', open.dismiss);
+        open.doc.removeEventListener('scroll', open.dismiss, { capture: true });
+        open.doc.removeEventListener('keydown', open.onKey);
+        PopupMenu._open = null;
+    }
+
+    static get isOpen() {
+        return !!PopupMenu._open;
+    }
+
+    // The text colour is set with the background: inherited from a dark-themed page it was light
+    // grey on this white panel, and every item but a disabled or danger one was unreadable.
+    static _panelStyle = {
+        background: '#fff', color: '#222', border: '1px solid #ccc', borderRadius: '3px', boxShadow: '0 2px 8px rgba(0,0,0,0.2)',
+        zIndex: '10000', minWidth: '170px', fontSize: '12px', fontFamily: 'sans-serif', padding: '4px 0',
+    };
+
+    static _panel(items, doc) {
+        return { attrs: { role: 'menu' }, children: items.map(item => PopupMenu._item(item, doc)) };
+    }
+
+    static _item(item, doc) {
+        if (item.separator) return { attrs: { role: 'separator' }, style: { borderTop: '1px solid #ddd', margin: '4px 0' } };
+        const hover = item.danger ? '#ffe8e8' : '#f0f0f0';
+        const base = {
+            attrs: { role: 'menuitem', 'aria-disabled': item.disabled ? 'true' : null, 'aria-checked': item.checked != null ? String(!!item.checked) : null },
+            style: {
+                padding: '7px 14px', cursor: item.disabled ? 'default' : 'pointer', position: 'relative', whiteSpace: 'nowrap',
+                color: item.disabled ? '#aaa' : item.danger ? '#cc3333' : '', background: item.checked ? '#e3f2fd' : '',
+            },
+        };
+        if (item.items) {
+            let sub;
+            return {
+                ...base,
+                attrs: { ...base.attrs, 'aria-haspopup': 'menu' },
+                on: {
+                    mouseenter: (e) => {
+                        e.currentTarget.style.background = hover;
+                        sub.style.display = 'block';
+                        // Opened near the window's right or bottom edge, it opens left, or lifts.
+                        const win = e.currentTarget.ownerDocument.defaultView;
+                        const box = sub.getBoundingClientRect?.();
+                        if (!win || !box?.width) return;
+                        const at = PopupMenu.submenuPlacement(e.currentTarget.getBoundingClientRect(), box.width, box.height, win.innerWidth, win.innerHeight);
+                        Object.assign(sub.style, at.side === 'left' ? { left: 'auto', right: '100%' } : { left: '100%', right: 'auto' }, { top: `${at.top}px` });
+                    },
+                    mouseleave: (e) => { e.currentTarget.style.background = ''; sub.style.display = 'none'; },
+                    click: (e) => e.stopPropagation(),
+                },
+                children: [
+                    `${item.label} ▸`,
+                    {
+                        ...PopupMenu._panel(item.items, doc),
+                        style: { ...PopupMenu._panelStyle, position: 'absolute', left: '100%', top: '-4px', display: 'none' },
+                        ref: (n) => { sub = n; },
+                    },
+                ],
+            };
+        }
+        return {
+            ...base,
+            text: item.label,
+            on: {
+                mouseenter: (e) => { if (!item.disabled) e.currentTarget.style.background = hover; },
+                mouseleave: (e) => { e.currentTarget.style.background = item.checked ? '#e3f2fd' : ''; },
+                click: (e) => {
+                    e.stopPropagation();
+                    if (item.disabled) return;
+                    PopupMenu.close();
+                    item.action();
+                },
+            },
+        };
+    }
+}

package/src/charting/charts/TableChart.js

@@ -87,7 +87,7 @@ export class TableChart extends Chart {
 
     _cell(text, column, left, top, colW, attrs) {
         const end = column.align === 'end';
-        this.renderer.text(text, end ? left + colW - TableChart.PAD_X : left + TableChart.PAD_X, top + TableChart.ROW_H / 2, {
+        return this.renderer.text(text, end ? left + colW - TableChart.PAD_X : left + TableChart.PAD_X, top + TableChart.ROW_H / 2, {
             textAnchor: end ? 'end' : 'start', verticalAlign: 'middle', fontSize: '12px', ...attrs,
         });
     }