@sheetpane/charts 0.0.0-stage → 0.3.0

package/dist/ui.js

@@ -0,0 +1,143 @@
+// @sheetpane/charts/ui — what charts adds to the grid's slots (W-21 DoD 1, "the action").
+// Opt-in: the headless entry never imports this file.
+//
+// The action itself — **Show source cells** — is a button on each chart's frame, in both modes:
+// it is the only place that knows which chart is meant. This entry adds two things the frame
+// cannot give:
+// - the status line: `Chart source: Holdings!E3:E15, H3:H15` while the selection lies in a
+//   chart's plotted cells or under its frame, else `2 charts` on a sheet that has some;
+// - a keyboard path to the same action (Mod+Shift+U, listed in the grid's keyboard help): it
+//   shows the source of the chart over the active cell, or of the sheet's only chart. The frame
+//   sits inside the grid's `role="img"` overlay wrapper, where a screen reader does not reach its
+//   button — the shortcut is the accessible route until the overlay contract lets an item be a group.
+// Not a `selbar` button: a selbar control has no "applies here" test, so it would show on every
+// selection, chart or not.
+import { registerPlugin } from '@sheetpane/grid';
+import { chartAt, chartModel, chartModelNow, charts, chartsOn, showSource } from './index.js';
+import { intersects, parseArea, parseCell, qualified, uniqueRanges } from './refs.js';
+/** The controls plugin's id. */
+export const UI_ID = 'charts-ui';
+/** The keyboard shortcut for Show source cells. */
+export const SHORTCUT = 'Mod+Shift+U';
+/**
+ * The ranges a chart reads, categories before values — the order the status line names them in.
+ *
+ * @param m - The chart model.
+ * @returns The ranges, without duplicates.
+ */
+export function sourceList(m) {
+    return uniqueRanges(m.series.flatMap((s) => [...(s.cat?.ranges ?? []), ...(s.val?.ranges ?? [])]));
+}
+/** Every parsed chart in the workbook whose plotted cells meet the selection. */
+function chartsReading(snap, sel) {
+    const book = snap.book;
+    const area = parseArea(sel.range ?? sel.ref);
+    if (!book || !area)
+        return [];
+    const out = [];
+    for (const s of book.sheets) {
+        for (const { path } of chartsOn(book, s.name)) {
+            const m = chartModelNow(book, path);
+            if (m && m.plotted.some((r) => r.sheet === sel.sheet && intersects(r, area)))
+                out.push(m);
+        }
+    }
+    return out;
+}
+/**
+ * The status line's text for a selection: `Chart source: Holdings!E3:E15, H3:H15` while it lies in a chart's plotted
+ * cells or under its frame, else `2 charts` on a sheet that has some. Charts not yet read count, but cannot be named.
+ *
+ * @param snap - A snapshot of the store.
+ * @param sel - The selection.
+ * @returns The text, or `''`.
+ */
+export function statusText(snap, sel) {
+    const book = snap.book;
+    if (!book)
+        return '';
+    let m = chartsReading(snap, sel)[0];
+    if (!m) {
+        const p = parseCell(sel.ref), hit = p && chartAt(book, sel.sheet, p.row, p.col);
+        m = (hit && chartModelNow(book, hit.path)) || undefined;
+    }
+    if (m) {
+        const list = sourceList(m);
+        return list.length ? `Chart source: ${list.map(qualified).join(', ')}` : 'Chart source: values stored in the chart';
+    }
+    const n = chartsOn(book, sel.sheet).length;
+    return n ? `${n} ${n === 1 ? 'chart' : 'charts'}` : '';
+}
+/**
+ * The chart the shortcut acts on: the one over the active cell, else the sheet's only chart.
+ *
+ * @param store - The workbook store.
+ * @param sel - The selection.
+ * @returns The chart part's path, or `undefined`.
+ */
+export function targetChart(store, sel) {
+    const p = parseCell(sel.ref);
+    const hit = p && chartAt(store.book, sel.sheet, p.row, p.col);
+    if (hit)
+        return hit.path;
+    const all = chartsOn(store.book, sel.sheet);
+    return all.length === 1 ? all[0].path : undefined;
+}
+const source = {
+    id: 'charts-source',
+    slot: 'status',
+    group: 'charts',
+    label: 'Show chart source cells',
+    shortcut: SHORTCUT,
+    mode: 'both',
+    text: (snap, sel) => statusText(snap, sel),
+    run: (store, sel) => {
+        const book = store.book, path = book && targetChart(store, sel);
+        if (!book || !path)
+            return;
+        void chartModel(book, path).then((m) => { if (m && store.book === book)
+            showSource(store, m); });
+    },
+};
+/**
+ * The charts controls: no hooks; a status line naming the source of the chart under the selection (or the sheet's
+ * chart count), and Mod+Shift+U for Show source cells — the keyboard route to each frame's button. Pair it with
+ * {@link charts}; importing this module makes `plugins="charts"` enable both.
+ *
+ * @returns The controls plugin (`id: 'charts-ui'`).
+ * @see https://github.com/arpitarya/sheetpane/blob/main/records/0113_CHARTS.md
+ * @example
+ * ```ts
+ * import { createWorkbook } from '@sheetpane/grid';
+ * import { charts } from '@sheetpane/charts';
+ * import { ui } from '@sheetpane/charts/ui';
+ *
+ * const book = createWorkbook({ plugins: [charts(), ui()] });
+ * ```
+ * @example
+ * ```ts
+ * import '@sheetpane/charts/ui'; // registers `charts` with its controls
+ * excel.setAttribute('plugins', 'charts');
+ * ```
+ */
+export function ui() {
+    return { id: UI_ID, provides: [], controls: [source] };
+}
+/**
+ * The charts plugin and its controls together.
+ *
+ * @param o - The charts plugin's options.
+ * @returns `[charts(o), ui()]`.
+ * @example
+ * ```ts
+ * import { createWorkbook } from '@sheetpane/grid';
+ * import { chartsWithUi } from '@sheetpane/charts/ui';
+ *
+ * const book = createWorkbook({ plugins: chartsWithUi({ draw: false }) });
+ * ```
+ */
+export function chartsWithUi(o = {}) {
+    return [charts(o), ui()];
+}
+registerPlugin('charts', () => chartsWithUi());
+//# sourceMappingURL=ui.js.map

package/dist/ui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.js","sourceRoot":"","sources":["../src/ui.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,sDAAsD;AACtD,EAAE;AACF,gGAAgG;AAChG,6FAA6F;AAC7F,eAAe;AACf,2FAA2F;AAC3F,wFAAwF;AACxF,6FAA6F;AAC7F,gGAAgG;AAChG,kGAAkG;AAClG,sGAAsG;AACtG,gGAAgG;AAChG,2BAA2B;AAC3B,OAAO,EAAE,cAAc,EAA0F,MAAM,iBAAiB,CAAC;AACzI,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAsB,MAAM,YAAY,CAAC;AAClH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAoB,MAAM,WAAW,CAAC;AAGxG,gCAAgC;AAChC,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC;AACjC,mDAAmD;AACnD,MAAM,CAAC,MAAM,QAAQ,GAAG,aAAa,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,CAAa;IACtC,OAAO,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrG,CAAC;AAED,iFAAiF;AACjF,SAAS,aAAa,CAAC,IAAc,EAAE,GAAc;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,MAAM,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,IAAI,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,IAAc,EAAE,GAAc;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;QAChF,CAAC,GAAG,CAAC,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,SAAS,CAAC;IAC1D,CAAC;IACD,IAAI,CAAC,EAAE,CAAC;QACN,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,0CAA0C,CAAC;IACtH,CAAC;IACD,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACzD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAoB,EAAE,GAAc;IAC9D,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9D,IAAI,GAAG;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED,MAAM,MAAM,GAAsB;IAChC,EAAE,EAAE,eAAe;IACnB,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,yBAAyB;IAChC,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;IAC1C,GAAG,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO;QAC3B,KAAK,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;YAAE,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,EAAE;IAChB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAAC,CAAC,GAAkB,EAAE;IAChD,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC;AAED,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@sheetpane/charts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.3.0",
+  "description": "Charts for sheetpane — a frame at the chart's anchor with its title and Show source cells; later, own SVG for bar, column, line, pie and scatter — through the `overlay` hook.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arpitarya/sheetpane.git",
+    "directory": "packages/charts"
+  },
+  "type": "module",
+  "sideEffects": [
+    "./dist/index.js",
+    "./dist/ui.js",
+    "./src/index.ts",
+    "./src/ui.ts"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./ui": {
+      "types": "./dist/ui.d.ts",
+      "import": "./dist/ui.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@sheetpane/grid": "0.3.0",
+    "@sheetpane/images": "0.3.0"
+  },
+  "dependencies": {
+    "@sheetpane/skills": "0.3.0"
+  },
+  "devDependencies": {
+    "@sheetpane/grid": "0.3.0",
+    "@sheetpane/images": "0.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
 }