react-cheminfo 0.9.0 → 0.11.0

package/lib/projection/core/loadingProfiles.d.ts

@@ -0,0 +1,87 @@
+import type { ChartExtent } from '../../chart/core/chartExtent.ts';
+import type { ProjectionVariablesView } from './projectionOptions.ts';
+import type { ProjectionAxis, ProjectionLoadings } from './projectionResult.ts';
+import type { VariableAxis } from './variableAxis.ts';
+/** One component's line or bars, everything a panel draws. */
+export interface LoadingProfile {
+    /** Which component, from 0. */
+    index: number;
+    /** What the panel is titled, e.g. `PC 2`. */
+    label: string;
+    /** The colour this component carries on every tab. */
+    color: string;
+    /**
+     * Its share of the differences, between 0 and 1, written after the title.
+     * @default undefined — nothing is written after the title
+     */
+    share?: number;
+    /** The values the panel draws, one per measurement, in the panel's own order. */
+    values: readonly number[];
+    /**
+     * The second line a panel draws, for a view that has two.
+     * @default undefined — the panel draws one line
+     */
+    secondValues?: readonly number[];
+}
+/** What the "what differs" tab draws, all of it. */
+export interface LoadingProfiles {
+    /** How the measurements are laid out, which decides a line or bars. */
+    axis: VariableAxis;
+    /** Which measurement each drawn slot is, so a tracking event can name it. */
+    order: Int32Array;
+    /**
+     * The average sample, in the measurements' own units and the drawn order —
+     * the faint reference line.
+     * @default undefined — no reference line is drawn
+     */
+    mean?: readonly number[];
+    /** One panel per component. */
+    profiles: readonly LoadingProfile[];
+    /** What the values measure, for the vertical axis. */
+    valueLabel: string;
+    /** Whether every panel shares one vertical scale. */
+    sharedScale: boolean;
+    /** The scale they share, when they do. */
+    domain: ChartExtent;
+    /** Which view produced them, for the legend sentence. */
+    view: ProjectionVariablesView;
+}
+/** How {@link loadingProfiles} builds its panels. */
+export interface LoadingProfilesOptions {
+    /** What loads onto each axis. */
+    loadings: ProjectionLoadings;
+    /** The axes, for the panel titles and their shares. */
+    axes: readonly ProjectionAxis[];
+    /** Which view to draw. */
+    view: ProjectionVariablesView;
+    /** How many components to draw. */
+    count: number;
+    /** How far along a component the average sample is pushed, in standard deviations. */
+    spread: number;
+    /** Whether every panel shares one vertical scale. */
+    sharedScale: boolean;
+    /** The order the measurements are drawn in. */
+    order: 'original' | 'strongest';
+    /**
+     * The one selected sample's scores, for the `sample` view.
+     * @default undefined — the `sample` view falls back to `weights`
+     */
+    sampleScores?: readonly number[];
+    /**
+     * What that sample is called, for the legend sentence.
+     * @default ''
+     */
+    sampleLabel?: string;
+}
+/**
+ * The panels of the "what differs" tab.
+ *
+ * A view whose data is not there falls back to `weights` rather than throwing
+ * or drawing nothing: `effect` needs the average and the spread, `rescaled`
+ * needs the scaling the model applied, and `sample` needs exactly one selected
+ * sample.
+ * @param options - See {@link LoadingProfilesOptions}.
+ * @returns Everything the tab draws.
+ */
+export declare function loadingProfiles(options: LoadingProfilesOptions): LoadingProfiles;
+//# sourceMappingURL=loadingProfiles.d.ts.map

package/lib/projection/core/loadingProfiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadingProfiles.d.ts","sourceRoot":"","sources":["../../../src/projection/core/loadingProfiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAKnE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAItD,8DAA8D;AAC9D,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC9B,uEAAuE;IACvE,IAAI,EAAE,YAAY,CAAC;IACnB,6EAA6E;IAC7E,KAAK,EAAE,UAAU,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAC;IACpC,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,WAAW,EAAE,OAAO,CAAC;IACrB,0CAA0C;IAC1C,MAAM,EAAE,WAAW,CAAC;IACpB,yDAAyD;IACzD,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,qDAAqD;AACrD,MAAM,WAAW,sBAAsB;IACrC,iCAAiC;IACjC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,uDAAuD;IACvD,IAAI,EAAE,SAAS,cAAc,EAAE,CAAC;IAChC,0BAA0B;IAC1B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,WAAW,EAAE,OAAO,CAAC;IACrB,+CAA+C;IAC/C,KAAK,EAAE,UAAU,GAAG,WAAW,CAAC;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,sBAAsB,GAC9B,eAAe,CA0GjB"}

package/lib/projection/core/loadingProfiles.js

@@ -0,0 +1,125 @@
+import { chartPadExtent } from "../../chart/core/chartExtent.js";
+import { chartSeriesColor } from "../../chart/core/chartPalette.js";
+import { variableCount } from "./variableAxis.js";
+import { drawableVariablesView } from "./variablesView.js";
+/**
+ * The panels of the "what differs" tab.
+ *
+ * A view whose data is not there falls back to `weights` rather than throwing
+ * or drawing nothing: `effect` needs the average and the spread, `rescaled`
+ * needs the scaling the model applied, and `sample` needs exactly one selected
+ * sample.
+ * @param options - See {@link LoadingProfilesOptions}.
+ * @returns Everything the tab draws.
+ */
+export function loadingProfiles(options) {
+    const { loadings, axes, count, spread, sharedScale, order, view: wanted, sampleScores, } = options;
+    const { weights, variables, mean, scales, spread: axisSpread, valueLabel = '', } = loadings;
+    const width = variableCount(variables);
+    const panels = Number.isFinite(count) ? Math.floor(count) : axes.length;
+    const drawn = Math.max(0, Math.min(panels, weights.rows, axes.length));
+    // An empty selection rather than an unknown one: the panels always know
+    // what is selected, and nothing selected is nothing to rebuild.
+    const view = drawableVariablesView(wanted, loadings, sampleScores ?? []);
+    // A number line cannot be reordered: a peak stands at its own position, so
+    // sorting the slots by strength would move every stick to a mass it was not
+    // measured at. The choice is only meaningful where the slots are a list.
+    const sortable = variables.kind === 'named' ? order : 'original';
+    const slots = slotOrder(sortable, weights, width, drawn);
+    // A panel in the measurements' own units starts from the average sample and
+    // walks away from it; one drawing weights starts from nothing at all.
+    const inUnits = view === 'effect' || view === 'sample';
+    const running = view === 'sample' ? new Float64Array(width) : null;
+    const profiles = [];
+    let low = Number.POSITIVE_INFINITY;
+    let high = Number.NEGATIVE_INFINITY;
+    for (let index = 0; index < drawn; index++) {
+        const values = new Array(width);
+        const second = view === 'effect' ? new Array(width) : null;
+        const reach = spread * (axisSpread?.[index] ?? 0);
+        const score = sampleScores?.[index] ?? 0;
+        for (let slot = 0; slot < width; slot++) {
+            const measurement = slots[slot] ?? slot;
+            const weight = weights.get(index, measurement);
+            const scale = scales?.[measurement] ?? 1;
+            const base = mean?.[measurement] ?? 0;
+            let value = weight;
+            if (view === 'rescaled') {
+                value = weight * scale;
+            }
+            else if (second !== null) {
+                const step = reach * weight * scale;
+                value = base + step;
+                second[slot] = base - step;
+                if (base - step < low)
+                    low = base - step;
+                if (base - step > high)
+                    high = base - step;
+            }
+            else if (running !== null) {
+                const total = (running[slot] ?? 0) + score * weight * scale;
+                running[slot] = total;
+                value = base + total;
+            }
+            values[slot] = value;
+            if (value < low)
+                low = value;
+            if (value > high)
+                high = value;
+        }
+        const axis = axes[index];
+        profiles.push({
+            index,
+            label: axis?.name ?? `Component ${index + 1}`,
+            color: chartSeriesColor(index, 'component'),
+            share: axis?.share,
+            values,
+            secondValues: second ?? undefined,
+        });
+    }
+    let reference;
+    if (inUnits && mean !== undefined) {
+        reference = new Array(width);
+        for (let slot = 0; slot < width; slot++) {
+            const value = mean[slots[slot] ?? slot] ?? 0;
+            reference[slot] = value;
+            if (value < low)
+                low = value;
+            if (value > high)
+                high = value;
+        }
+    }
+    const padded = chartPadExtent({ min: low, max: high });
+    return {
+        axis: variables,
+        order: slots,
+        mean: reference,
+        profiles,
+        // Weights are a share of a direction, not a quantity anybody measured.
+        valueLabel: view === 'weights' ? 'Weight' : valueLabel,
+        sharedScale,
+        // Bars are read from the zero line, so the line has to be on the panel; a
+        // spectrum sitting on a baseline would be squashed into its top third by
+        // the same rule, so it is only applied where a value means a weight.
+        domain: inUnits
+            ? padded
+            : { min: Math.min(padded.min, 0), max: Math.max(padded.max, 0) },
+        view,
+    };
+}
+function slotOrder(order, weights, width, drawn) {
+    const slots = new Int32Array(width);
+    for (let index = 0; index < width; index++)
+        slots[index] = index;
+    if (order === 'original' || drawn === 0)
+        return slots;
+    // Every panel takes the order the strongest component puts the measurements
+    // in. Sorting each panel to its own component would move a measurement from
+    // slot to slot down the stack, and the stack is read down a column.
+    const strength = new Float64Array(width);
+    for (let index = 0; index < width; index++) {
+        strength[index] = Math.abs(weights.get(0, index));
+    }
+    return slots.toSorted((left, right) => (strength[right] ?? 0) - (strength[left] ?? 0));
+}
+//# sourceMappingURL=loadingProfiles.js.map

package/lib/projection/core/loadingProfiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadingProfiles.js","sourceRoot":"","sources":["../../../src/projection/core/loadingProfiles.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAMpE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AA4E3D;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EACJ,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,MAAM,EACN,WAAW,EACX,KAAK,EACL,IAAI,EAAE,MAAM,EACZ,YAAY,GACb,GAAG,OAAO,CAAC;IACZ,MAAM,EACJ,OAAO,EACP,SAAS,EACT,IAAI,EACJ,MAAM,EACN,MAAM,EAAE,UAAU,EAClB,UAAU,GAAG,EAAE,GAChB,GAAG,QAAQ,CAAC;IACb,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IACxE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,wEAAwE;IACxE,gEAAgE;IAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;IACzE,2EAA2E;IAC3E,4EAA4E;IAC5E,yEAAyE;IACzE,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;IACjE,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAEzD,4EAA4E;IAC5E,sEAAsE;IACtE,MAAM,OAAO,GAAG,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,CAAC;IACvD,MAAM,OAAO,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACnE,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,IAAI,GAAG,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACnC,IAAI,IAAI,GAAG,MAAM,CAAC,iBAAiB,CAAC;IAEpC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnE,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,YAAY,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC;YACxC,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;YACxC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACtC,IAAI,KAAK,GAAG,MAAM,CAAC;YACnB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;gBACxB,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;YACzB,CAAC;iBAAM,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAC3B,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;gBACpC,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;gBAC3B,IAAI,IAAI,GAAG,IAAI,GAAG,GAAG;oBAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;gBACzC,IAAI,IAAI,GAAG,IAAI,GAAG,IAAI;oBAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAC7C,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;gBAC5D,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;gBACtB,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;YACvB,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACrB,IAAI,KAAK,GAAG,GAAG;gBAAE,GAAG,GAAG,KAAK,CAAC;YAC7B,IAAI,KAAK,GAAG,IAAI;gBAAE,IAAI,GAAG,KAAK,CAAC;QACjC,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK;YACL,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,aAAa,KAAK,GAAG,CAAC,EAAE;YAC7C,KAAK,EAAE,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC;YAC3C,KAAK,EAAE,IAAI,EAAE,KAAK;YAClB,MAAM;YACN,YAAY,EAAE,MAAM,IAAI,SAAS;SAClC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,SAA+B,CAAC;IACpC,IAAI,OAAO,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QAClC,SAAS,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC;QACrC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7C,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACxB,IAAI,KAAK,GAAG,GAAG;gBAAE,GAAG,GAAG,KAAK,CAAC;YAC7B,IAAI,KAAK,GAAG,IAAI;gBAAE,IAAI,GAAG,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,SAAS;QACf,QAAQ;QACR,uEAAuE;QACvE,UAAU,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU;QACtD,WAAW;QACX,0EAA0E;QAC1E,yEAAyE;QACzE,qEAAqE;QACrE,MAAM,EAAE,OAAO;YACb,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE;QAClE,IAAI;KACL,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,KAA+B,EAC/B,OAAmB,EACnB,KAAa,EACb,KAAa;IAEb,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,EAAE;QAAE,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACjE,IAAI,KAAK,KAAK,UAAU,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEtD,4EAA4E;IAC5E,4EAA4E;IAC5E,oEAAoE;IACpE,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACzC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;QAC3C,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CACnB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC"}

package/lib/projection/core/pcaLike.d.ts

@@ -0,0 +1,32 @@
+import type { MatrixLike } from '../../chart/core/matrix.ts';
+/**
+ * A fitted principal component analysis, described structurally so that
+ * nothing in this package imports `ml-pca`.
+ *
+ * `ml-pca`'s `PCA` satisfies it as it stands, with no adapter and no cast.
+ * `getEigenvectors`, `getStandardDeviations`, `invert` and `toJSON` are
+ * deliberately absent: nothing here needs them, and `getEigenvectors` hands
+ * out the model's live internal matrix, which a component library must never
+ * be given.
+ */
+export interface PcaLike {
+    /**
+     * Place samples in the model's space.
+     * @param samples - One array per sample, one value per original measurement.
+     * @param options - `nComponents` keeps only the first few columns.
+     * @param options.nComponents - How many of them to keep.
+     * @returns One row per sample, one column per kept component.
+     */
+    predict: (samples: number[][], options?: {
+        nComponents?: number;
+    }) => MatrixLike;
+    /** The share of the variance each component carries, as fractions summing to 1 — never percentages. */
+    getExplainedVariance: () => number[];
+    /** The running total of the above; the last value is 1 to within float error, so never compare it to 1. */
+    getCumulativeVariance: () => number[];
+    /** The variance of each component's own scores. */
+    getEigenvalues: () => number[];
+    /** Row `i` is component `i`, column `j` is original measurement `j`. */
+    getLoadings: () => MatrixLike;
+}
+//# sourceMappingURL=pcaLike.d.ts.map

package/lib/projection/core/pcaLike.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pcaLike.d.ts","sourceRoot":"","sources":["../../../src/projection/core/pcaLike.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;OAMG;IACH,OAAO,EAAE,CACP,OAAO,EAAE,MAAM,EAAE,EAAE,EACnB,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,KAC/B,UAAU,CAAC;IAChB,uGAAuG;IACvG,oBAAoB,EAAE,MAAM,MAAM,EAAE,CAAC;IACrC,2GAA2G;IAC3G,qBAAqB,EAAE,MAAM,MAAM,EAAE,CAAC;IACtC,mDAAmD;IACnD,cAAc,EAAE,MAAM,MAAM,EAAE,CAAC;IAC/B,wEAAwE;IACxE,WAAW,EAAE,MAAM,UAAU,CAAC;CAC/B"}

package/lib/projection/core/pcaLike.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pcaLike.js.map

package/lib/projection/core/pcaLike.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pcaLike.js","sourceRoot":"","sources":["../../../src/projection/core/pcaLike.ts"],"names":[],"mappings":""}

package/lib/projection/core/pcaResult.d.ts

@@ -0,0 +1,86 @@
+import type { MatrixLike } from '../../chart/core/matrix.ts';
+import type { PcaLike } from './pcaLike.ts';
+import type { ProjectionResult } from './projectionResult.ts';
+import type { VariableAxis } from './variableAxis.ts';
+/** How a {@link ProjectionResult} is built from a fitted model. */
+export interface PcaResultOptions {
+    /**
+     * The measurements the model was fitted on, one array per sample. They are
+     * read in place: the average and the spread of each measurement are
+     * accumulated in one centred pass and nothing is copied.
+     */
+    rows: readonly number[][];
+    /**
+     * Further samples to place into the finished model, one array per sample,
+     * each as wide as a row of `rows`.
+     *
+     * These took no part in fitting: the axes were already chosen when they
+     * arrived. They are appended after the fitted samples and drawn hollow, so a
+     * reader can see at a glance which points the model has already accounted
+     * for and which it is being asked about — a new batch, a suspected outlier,
+     * next year's measurements against last year's model.
+     *
+     * They are placed by one further `predict` call, and the two sets of scores
+     * are read as one table without either being copied.
+     * @default undefined — every sample built the model
+     */
+    projected?: readonly number[][];
+    /**
+     * How the original measurements are laid out.
+     * @default the columns numbered `1` to `n`, drawn as bars
+     */
+    variables?: VariableAxis;
+    /**
+     * Where the samples landed. Left out, they are placed by projecting `rows`
+     * through the model, which is one call.
+     * @default the model's own projection of `rows`
+     */
+    scores?: MatrixLike;
+    /**
+     * Whether the model divided each measurement by its spread — the `scale`
+     * given to `new PCA(...)`. It cannot be read back from the model's public
+     * surface, and getting it wrong offers a view that is the same drawing
+     * twice.
+     * @default false
+     */
+    scaled?: boolean;
+    /**
+     * How many components to keep.
+     * @default every component the model holds
+     */
+    count?: number;
+    /**
+     * What the measured values are, e.g. `Absorbance`.
+     * @default ''
+     */
+    valueLabel?: string;
+    /**
+     * Whether each component is flipped so that its strongest measurement comes
+     * out positive. The direction of a component is arbitrary and flips when the
+     * model is refitted — on iris, refitting on fifty of the hundred and fifty
+     * flowers turned the first component's weights right around — so without
+     * this a map mirrors itself when one sample is added, which reads as a fault
+     * to everyone who is not a statistician. The scores are flipped with the
+     * weights, through a mapped view rather than a copy.
+     * @default 'largest-positive'
+     */
+    signConvention?: 'largest-positive' | 'none';
+    /**
+     * What the method is called in the headings.
+     * @default 'Principal components'
+     */
+    method?: string;
+}
+/**
+ * A fitted principal component model as the viewer reads it.
+ * @param pca - The fitted model.
+ * @param options - See {@link PcaResultOptions}.
+ * @returns The result, with every tab's data filled in.
+ * @throws {Error} When `rows` is empty, when a row's length differs from the
+ * first row's, when a measurement is not a finite number, or when the model's
+ * loadings are not as wide as a row — which is what happens when the model was
+ * fitted with `ignoreZeroVariance` and silently dropped a column, and which
+ * would otherwise label every loadings panel one measurement out.
+ */
+export declare function pcaResult(pca: PcaLike, options: PcaResultOptions): ProjectionResult;
+//# sourceMappingURL=pcaResult.d.ts.map

package/lib/projection/core/pcaResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pcaResult.d.ts","sourceRoot":"","sources":["../../../src/projection/core/pcaResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAG7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAkB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,mEAAmE;AACnE,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,CAAC;IAC1B;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,EAAE,CAAC;IAChC;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC7C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,OAAO,EAAE,gBAAgB,GACxB,gBAAgB,CA8DlB"}

package/lib/projection/core/pcaResult.js

@@ -0,0 +1,122 @@
+import { mappedMatrix, stackedMatrix } from "../../chart/core/matrix.js";
+/**
+ * A fitted principal component model as the viewer reads it.
+ * @param pca - The fitted model.
+ * @param options - See {@link PcaResultOptions}.
+ * @returns The result, with every tab's data filled in.
+ * @throws {Error} When `rows` is empty, when a row's length differs from the
+ * first row's, when a measurement is not a finite number, or when the model's
+ * loadings are not as wide as a row — which is what happens when the model was
+ * fitted with `ignoreZeroVariance` and silently dropped a column, and which
+ * would otherwise label every loadings panel one measurement out.
+ */
+export function pcaResult(pca, options) {
+    const { rows, projected, variables, scores, scaled = false, count, valueLabel = '', signConvention = 'largest-positive', method = 'Principal components', } = options;
+    const first = rows[0];
+    if (first === undefined) {
+        throw new Error('pcaResult was given no rows, so nothing can be read.');
+    }
+    const width = first.length;
+    const { mean, deviation } = columnStats(rows, width);
+    const weights = pca.getLoadings();
+    if (weights.columns < width) {
+        throw new Error(`pcaResult was given rows ${width} measurements wide but a model holding ${weights.columns} weights, which is what \`ignoreZeroVariance\` leaves behind when it drops a column that never moves. Every panel after the dropped one would carry its neighbour's name.`);
+    }
+    const wanted = Number.isFinite(count) ? Math.floor(count ?? 0) : weights.rows;
+    const kept = Math.min(weights.rows, Math.max(1, wanted));
+    const signs = signsOf(weights, signConvention === 'largest-positive');
+    const explained = pca.getExplainedVariance();
+    const eigenvalues = pca.getEigenvalues();
+    const axes = [];
+    const spread = [];
+    for (let index = 0; index < kept; index++) {
+        const eigenvalue = eigenvalues[index];
+        axes.push({ name: `PC${index + 1}`, share: explained[index], eigenvalue });
+        spread.push(Math.sqrt(Math.max(0, eigenvalue ?? 0)));
+    }
+    const fitted = scores ?? pca.predict(rows, { nComponents: kept });
+    const extra = projected === undefined || projected.length === 0
+        ? undefined
+        : pca.predict(projected, { nComponents: kept });
+    const placed = extra === undefined ? fitted : stackedMatrix(fitted, extra);
+    return {
+        method,
+        axes,
+        scores: signedView(placed, placed.rows, kept, signs, false),
+        fittedCount: extra === undefined ? undefined : fitted.rows,
+        loadings: {
+            weights: signedView(weights, kept, width, signs, true),
+            variables: variables ?? numberedVariables(width),
+            mean,
+            spread,
+            scales: scaled ? deviation : undefined,
+            valueLabel,
+        },
+    };
+}
+function columnStats(rows, width) {
+    // Centred on the average so far, in one pass: a running total of the raw
+    // values squared loses the low bits of a spectrum sitting on a baseline.
+    // `deviation` carries the squared spread until the last loop roots it.
+    const mean = new Array(width).fill(0);
+    const deviation = new Array(width).fill(0);
+    for (let index = 0; index < rows.length; index++) {
+        const row = rows[index];
+        if (row?.length !== width) {
+            throw new Error(`pcaResult was given a row ${row?.length ?? 0} measurements wide at index ${index}, where the first row is ${width} wide.`);
+        }
+        const seen = index + 1;
+        for (let column = 0; column < width; column++) {
+            const value = row[column];
+            if (value === undefined || !Number.isFinite(value)) {
+                throw new Error(`pcaResult was given ${String(value)} at row ${index}, measurement ${column}. A model carries it on into a map of nothing at all.`);
+            }
+            const before = mean[column] ?? 0;
+            const step = value - before;
+            const after = before + step / seen;
+            mean[column] = after;
+            deviation[column] = (deviation[column] ?? 0) + step * (value - after);
+        }
+    }
+    const divisor = Math.max(1, rows.length - 1);
+    for (let column = 0; column < width; column++) {
+        deviation[column] = Math.sqrt((deviation[column] ?? 0) / divisor);
+    }
+    return { mean, deviation };
+}
+function signsOf(weights, flip) {
+    const signs = new Float64Array(weights.rows).fill(1);
+    if (!flip)
+        return signs;
+    for (let row = 0; row < weights.rows; row++) {
+        let strongest = 0;
+        let reach = 0;
+        for (let column = 0; column < weights.columns; column++) {
+            const value = weights.get(row, column);
+            const size = Math.abs(value);
+            if (size > reach) {
+                reach = size;
+                strongest = value;
+            }
+        }
+        if (strongest < 0)
+            signs[row] = -1;
+    }
+    return signs;
+}
+function signedView(source, rowCount, columnCount, signs, byRow) {
+    return mappedMatrix({
+        rows: rowCount,
+        columns: columnCount,
+        get: (row, column) => row >= 0 && row < rowCount && column >= 0 && column < columnCount
+            ? source.get(row, column)
+            : Number.NaN,
+    }, (value, row, column) => value * (signs[byRow ? row : column] ?? 1));
+}
+function numberedVariables(width) {
+    const names = new Array(width);
+    for (let index = 0; index < width; index++)
+        names[index] = String(index + 1);
+    return { kind: 'named', names };
+}
+//# sourceMappingURL=pcaResult.js.map

package/lib/projection/core/pcaResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pcaResult.js","sourceRoot":"","sources":["../../../src/projection/core/pcaResult.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AA4EzE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,OAAyB;IAEzB,MAAM,EACJ,IAAI,EACJ,SAAS,EACT,SAAS,EACT,MAAM,EACN,MAAM,GAAG,KAAK,EACd,KAAK,EACL,UAAU,GAAG,EAAE,EACf,cAAc,GAAG,kBAAkB,EACnC,MAAM,GAAG,sBAAsB,GAChC,GAAG,OAAO,CAAC;IAEZ,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;IAC3B,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAErD,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IAClC,IAAI,OAAO,CAAC,OAAO,GAAG,KAAK,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,4BAA4B,KAAK,0CAA0C,OAAO,CAAC,OAAO,2KAA2K,CACtQ,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IAC9E,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,cAAc,KAAK,kBAAkB,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,GAAG,CAAC,oBAAoB,EAAE,CAAC;IAC7C,MAAM,WAAW,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;IAEzC,MAAM,IAAI,GAAqB,EAAE,CAAC;IAClC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,KAAK,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,MAAM,GACV,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,IAAkB,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,MAAM,KAAK,GACT,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAC/C,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAuB,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3E,OAAO;QACL,MAAM;QACN,IAAI;QACJ,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC;QAC3D,WAAW,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI;QAC1D,QAAQ,EAAE;YACR,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;YACtD,SAAS,EAAE,SAAS,IAAI,iBAAiB,CAAC,KAAK,CAAC;YAChD,IAAI;YACJ,MAAM;YACN,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YACtC,UAAU;SACX;KACF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,IAAyB,EACzB,KAAa;IAEb,yEAAyE;IACzE,yEAAyE;IACzE,uEAAuE;IACvE,MAAM,IAAI,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,GAAG,EAAE,MAAM,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6BAA6B,GAAG,EAAE,MAAM,IAAI,CAAC,+BAA+B,KAAK,4BAA4B,KAAK,QAAQ,CAC3H,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC,CAAC;QACvB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnD,MAAM,IAAI,KAAK,CACb,uBAAuB,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,iBAAiB,MAAM,uDAAuD,CACnI,CAAC;YACJ,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YACrB,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7C,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;QAC9C,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC7B,CAAC;AAED,SAAS,OAAO,CAAC,OAAmB,EAAE,IAAa;IACjD,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QAC5C,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;YACxD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC7B,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;gBACjB,KAAK,GAAG,IAAI,CAAC;gBACb,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,SAAS,GAAG,CAAC;YAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CACjB,MAAkB,EAClB,QAAgB,EAChB,WAAmB,EACnB,KAAmB,EACnB,KAAc;IAEd,OAAO,YAAY,CACjB;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,WAAW;QACpB,GAAG,EAAE,CAAC,GAAW,EAAE,MAAc,EAAE,EAAE,CACnC,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,QAAQ,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,GAAG,WAAW;YAC/D,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;YACzB,CAAC,CAAC,MAAM,CAAC,GAAG;KACjB,EACD,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CACnE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC;IACvC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,EAAE;QAAE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC7E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAClC,CAAC"}

package/lib/projection/core/projectionCopy.d.ts

@@ -0,0 +1,134 @@
+import type { ProjectionCopyPatch } from './projectionCopyPatch.ts';
+import type { ProjectionOptionId } from './projectionOptions.ts';
+import type { ProjectionBarWords, ProjectionHelp } from './projectionStrings.ts';
+import type { ProjectionTab } from './projectionTabs.ts';
+export type { ProjectionBarWords, ProjectionHelp, ProjectionHelpExample, } from './projectionStrings.ts';
+/** Every word a projection viewer writes. */
+export interface ProjectionCopy {
+    /** What each tab is called. */
+    tab: Record<ProjectionTab, string>;
+    /** What each tab is called on a bar with no room for the long name. */
+    shortTab: Record<ProjectionTab, string>;
+    /** The words the settings bar writes on itself. */
+    bar: ProjectionBarWords;
+    /** The sentence under each tab and above its figure. */
+    intro: {
+        /** The map. */
+        map: string;
+        /** The cloud. */
+        space: string;
+        /** The pair grid. */
+        pairs: string;
+        /**
+         * The "what differs" tab showing weights over a number line. Carries
+         * `{axis}`.
+         */
+        variablesContinuous: string;
+        /** The same, over named measurements, which are drawn as bars. */
+        variablesNamed: string;
+        /** The same tab in its "effect on a sample" view, whatever the axis is. */
+        variablesEffect: string;
+        /** The same tab in its "selected sample" view. */
+        variablesSample: string;
+        /** The shares tab. */
+        shares: string;
+    };
+    /** The sentence naming what colour and shape mean, one per tab and per view. */
+    legend: {
+        /** The map. Carries `{groups}` and `{coverage}`. */
+        map: string;
+        /** The cloud. Carries `{groups}` and `{coverage}`. */
+        space: string;
+        /** The map with no outlines. Carries `{groups}`. */
+        mapNoEllipse: string;
+        /** The pair grid. Carries `{groups}`. */
+        pairs: string;
+        /** The "effect on a sample" view. */
+        variablesEffect: string;
+        /** The "weights" view. */
+        variablesWeights: string;
+        /** The "weights in your units" view. */
+        variablesRescaled: string;
+        /** The "selected sample" view. Carries `{sample}`. */
+        variablesSample: string;
+        /** The shares tab. */
+        shares: string;
+    };
+    /** The sentences the viewer builds from the data. */
+    sentence: {
+        /** Carries `{percent}`. */
+        sharesFirst: string;
+        /** Carries `{count}` and `{percent}`. */
+        sharesTarget: string;
+        /** Carries `{count}` and `{percent}`. */
+        sharesNoTarget: string;
+        /** Carries `{count}` and `{total}`. */
+        selection: string;
+        /** What is said when nothing is selected. */
+        selectionNone: string;
+        /** What is said while a plain drag is under way. */
+        lassoReplace: string;
+        /** While a shift-drag is under way. */
+        lassoAdd: string;
+        /** While an alt-drag is under way. */
+        lassoRemove: string;
+        /** Carries `{names}`. */
+        skippedGroups: string;
+    };
+    /** What the buttons read. */
+    action: {
+        /** Frames the selected samples. */
+        zoomToSelection: string;
+        /** Puts the axes back. */
+        resetView: string;
+        /** Empties the selection. */
+        clearSelection: string;
+        /** Takes the figure off the page as a file. */
+        download: string;
+        /** What the floating bar is called. */
+        options: string;
+    };
+    /** The help behind every option's glyph. */
+    help: Record<ProjectionOptionId, ProjectionHelp>;
+    /** The nouns the viewer builds its sentences from. */
+    words: {
+        /** What one row is called. */
+        sample: string;
+        /** What many rows are called. */
+        samples: string;
+        /** What one axis is called. */
+        component: string;
+        /** What many are called. */
+        components: string;
+    };
+}
+/**
+ * The words the viewer writes when a site overrides nothing.
+ *
+ * Two words are kept out of it deliberately. Nothing is ever "reconstructed",
+ * because the reader is being shown their own samples and the word suggests a
+ * repair. Nothing is ever a "variance" either: the quantity every component
+ * carries a share of is written as the differences between your samples, which
+ * is what it is, and the one place a spread has to be named it is named in
+ * standard deviations.
+ */
+export declare const PROJECTION_COPY: ProjectionCopy;
+/**
+ * The words the viewer will write, with a site's overrides merged in one key
+ * at a time, so a site fixing a single sentence keeps every other default.
+ * @param overrides - What the site wants said differently.
+ * @returns Every word, complete.
+ */
+export declare function mergeProjectionCopy(overrides?: ProjectionCopyPatch<ProjectionCopy>): ProjectionCopy;
+/**
+ * A sentence with its placeholders filled in.
+ *
+ * The placeholders are `{name}`, and one with no value is left in place rather
+ * than replaced by an empty string, so a site that mistypes a key sees the
+ * mistake in the figure instead of a sentence that quietly loses a number.
+ * @param template - The sentence, from {@link ProjectionCopy}.
+ * @param values - What each placeholder stands for.
+ * @returns The filled sentence.
+ */
+export declare function fillCopy(template: string, values: Readonly<Record<string, string>>): string;
+//# sourceMappingURL=projectionCopy.d.ts.map

package/lib/projection/core/projectionCopy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionCopy.d.ts","sourceRoot":"","sources":["../../../src/projection/core/projectionCopy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAMhC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAEhC,6CAA6C;AAC7C,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACnC,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACxC,mDAAmD;IACnD,GAAG,EAAE,kBAAkB,CAAC;IACxB,wDAAwD;IACxD,KAAK,EAAE;QACL,eAAe;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,iBAAiB;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,qBAAqB;QACrB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAC5B,kEAAkE;QAClE,cAAc,EAAE,MAAM,CAAC;QACvB,2EAA2E;QAC3E,eAAe,EAAE,MAAM,CAAC;QACxB,kDAAkD;QAClD,eAAe,EAAE,MAAM,CAAC;QACxB,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,gFAAgF;IAChF,MAAM,EAAE;QACN,oDAAoD;QACpD,GAAG,EAAE,MAAM,CAAC;QACZ,sDAAsD;QACtD,KAAK,EAAE,MAAM,CAAC;QACd,oDAAoD;QACpD,YAAY,EAAE,MAAM,CAAC;QACrB,yCAAyC;QACzC,KAAK,EAAE,MAAM,CAAC;QACd,qCAAqC;QACrC,eAAe,EAAE,MAAM,CAAC;QACxB,0BAA0B;QAC1B,gBAAgB,EAAE,MAAM,CAAC;QACzB,wCAAwC;QACxC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,sDAAsD;QACtD,eAAe,EAAE,MAAM,CAAC;QACxB,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,qDAAqD;IACrD,QAAQ,EAAE;QACR,2BAA2B;QAC3B,WAAW,EAAE,MAAM,CAAC;QACpB,yCAAyC;QACzC,YAAY,EAAE,MAAM,CAAC;QACrB,yCAAyC;QACzC,cAAc,EAAE,MAAM,CAAC;QACvB,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,6CAA6C;QAC7C,aAAa,EAAE,MAAM,CAAC;QACtB,oDAAoD;QACpD,YAAY,EAAE,MAAM,CAAC;QACrB,uCAAuC;QACvC,QAAQ,EAAE,MAAM,CAAC;QACjB,sCAAsC;QACtC,WAAW,EAAE,MAAM,CAAC;QACpB,yBAAyB;QACzB,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,6BAA6B;IAC7B,MAAM,EAAE;QACN,mCAAmC;QACnC,eAAe,EAAE,MAAM,CAAC;QACxB,0BAA0B;QAC1B,SAAS,EAAE,MAAM,CAAC;QAClB,6BAA6B;QAC7B,cAAc,EAAE,MAAM,CAAC;QACvB,+CAA+C;QAC/C,QAAQ,EAAE,MAAM,CAAC;QACjB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;IACjD,sDAAsD;IACtD,KAAK,EAAE;QACL,8BAA8B;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,iCAAiC;QACjC,OAAO,EAAE,MAAM,CAAC;QAChB,+BAA+B;QAC/B,SAAS,EAAE,MAAM,CAAC;QAClB,4BAA4B;QAC5B,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,EAAE,cAyE7B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAC9C,cAAc,CAMhB;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACvC,MAAM,CAKR"}