react-cheminfo 0.9.0 → 0.11.0

package/lib/projection/ui/projectionMapChrome.d.ts

@@ -0,0 +1,81 @@
+/**
+ * The words one map writes around its own picture: the legend that says what
+ * colour and shape mean on it, and the sentences under it.
+ *
+ * They are built here rather than in the component so that what the figure
+ * claims can be read, and tested, without rendering a chart — which is the
+ * only way a promise like "this outline covers 95 % of the group" stays
+ * honest as the controls around it change.
+ */
+import type { OverlayLegendEntry } from '../../overlay/ui/OverlayLegend.tsx';
+import type { EllipseSize } from '../../scatter/core/confidenceEllipse.ts';
+import type { ProjectionCopy } from '../core/projectionCopy.ts';
+import type { ProjectionMarker } from '../core/projectionResult.ts';
+import type { ResolvedProjectionGroups } from '../core/projectionSamples.ts';
+/** What the map's chrome is built from. */
+export interface ProjectionMapChromeInput {
+    /** The words the map writes, already merged over the defaults. */
+    copy: ProjectionCopy;
+    /** The groups as the map colours them. */
+    groups: ResolvedProjectionGroups;
+    /** Whether colour stands for the group at all. */
+    colored: boolean;
+    /** How large the group outlines are, or `null` for none. */
+    ellipse: EllipseSize | null;
+    /** How many samples a group needs before it is outlined at all. */
+    minimumPoints: number;
+    /** Whether each group's average is marked with a cross. */
+    showGroupMeans: boolean;
+    /** The reference points drawn over the cloud. */
+    markers: readonly ProjectionMarker[];
+    /** How many leading rows the model was built from. */
+    fittedCount: number;
+    /** How many rows there are in all. */
+    total: number;
+    /**
+     * Which figure the chrome is for. The cloud says the same things about
+     * itself, in its own words and about its own geometry: a share is a wider
+     * shape in three dimensions than in two, so the sentence promising one has
+     * to be built from the dimension it will be read in.
+     * @default 'map'
+     */
+    figure?: 'map' | 'space';
+}
+/** The legend and the standing caption of one map. */
+export interface ProjectionMapChrome {
+    /**
+     * The sentence over the legend, naming what colour and shape mean here.
+     *
+     * It is one short clause, because the legend floats on the picture and its
+     * title is written on a single line: everything else the encoding needs
+     * explaining with — how much of a group an outline holds — is in the
+     * caption, which the reader opens rather than reads over the data.
+     */
+    title: string;
+    /** The legend's entries, in the order they are written. */
+    entries: OverlayLegendEntry[];
+    /** The paragraph the map's question mark hands back. */
+    caption: string;
+}
+/**
+ * The legend and the caption of one map.
+ *
+ * The legend's title always names the encoding, because a reader who cannot
+ * say what the colour stands for carries the wrong meaning from one tab to the
+ * next. And every mark the figure can draw that is not a plain filled dot — a
+ * group average, a cluster centre, a sample the model never saw — earns an
+ * entry, because a mark nobody named is a mark the reader counts as one more
+ * group.
+ * @param input - See {@link ProjectionMapChromeInput}.
+ * @returns The legend's title and entries, and the standing caption.
+ */
+export declare function projectionMapChrome(input: ProjectionMapChromeInput): ProjectionMapChrome;
+/**
+ * The sentence reporting what a gesture picked out.
+ * @param copy - The words the map writes.
+ * @param count - How many samples are selected.
+ * @param total - How many there are in all.
+ * @returns The sentence.
+ */
+export declare function projectionSelectionSentence(copy: ProjectionCopy, count: number, total: number): string;
+//# sourceMappingURL=projectionMapChrome.d.ts.map

package/lib/projection/ui/projectionMapChrome.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionMapChrome.d.ts","sourceRoot":"","sources":["../../../src/projection/ui/projectionMapChrome.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAM7E,2CAA2C;AAC3C,MAAM,WAAW,wBAAwB;IACvC,kEAAkE;IAClE,IAAI,EAAE,cAAc,CAAC;IACrB,0CAA0C;IAC1C,MAAM,EAAE,wBAAwB,CAAC;IACjC,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,4DAA4D;IAC5D,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,mEAAmE;IACnE,aAAa,EAAE,MAAM,CAAC;IACtB,2DAA2D;IAC3D,cAAc,EAAE,OAAO,CAAC;IACxB,iDAAiD;IACjD,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACrC,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC;CAC1B;AAED,sDAAsD;AACtD,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,wBAAwB,GAC9B,mBAAmB,CAqDrB;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,MAAM,CAMR"}

package/lib/projection/ui/projectionMapChrome.js

@@ -0,0 +1,139 @@
+/**
+ * The words one map writes around its own picture: the legend that says what
+ * colour and shape mean on it, and the sentences under it.
+ *
+ * They are built here rather than in the component so that what the figure
+ * claims can be read, and tested, without rendering a chart — which is the
+ * only way a promise like "this outline covers 95 % of the group" stays
+ * honest as the controls around it change.
+ */
+import { fillCopy } from "../core/projectionCopy.js";
+import { ellipseCoverageText } from "./projectionEllipse.js";
+import { ellipsoidCoverageText } from "./projectionEllipsoid.js";
+import { UNGROUPED_INK } from "./projectionMapModel.js";
+/**
+ * The legend and the caption of one map.
+ *
+ * The legend's title always names the encoding, because a reader who cannot
+ * say what the colour stands for carries the wrong meaning from one tab to the
+ * next. And every mark the figure can draw that is not a plain filled dot — a
+ * group average, a cluster centre, a sample the model never saw — earns an
+ * entry, because a mark nobody named is a mark the reader counts as one more
+ * group.
+ * @param input - See {@link ProjectionMapChromeInput}.
+ * @returns The legend's title and entries, and the standing caption.
+ */
+export function projectionMapChrome(input) {
+    const { copy, groups, colored, ellipse, showGroupMeans, markers } = input;
+    const { minimumPoints, fittedCount, total, figure = 'map' } = input;
+    const entries = [];
+    const skipped = [];
+    if (colored) {
+        for (const entry of groups.entries) {
+            const thin = ellipse !== null && entry.count < minimumPoints;
+            if (thin)
+                skipped.push(entry.label);
+            entries.push({
+                id: entry.id,
+                label: entry.label,
+                color: entry.color,
+                shape: 'dot',
+                count: entry.count,
+                note: thin ? NOT_OUTLINED_NOTE : undefined,
+            });
+        }
+        if (showGroupMeans) {
+            entries.push({
+                id: 'group-average',
+                label: copy.help.showGroupMeans.title,
+                color: UNGROUPED_INK,
+                shape: 'cross',
+            });
+        }
+    }
+    appendMarkerEntries(entries, markers, groups);
+    const hollow = fittedCount < total;
+    if (hollow) {
+        entries.push({
+            id: 'projected',
+            label: HOLLOW_LEGEND_LABEL,
+            color: 'var(--text-muted)',
+            shape: 'ring',
+        });
+    }
+    return {
+        title: legendTitle(copy, groups, colored),
+        entries,
+        caption: captionFor(copy, groups, colored, ellipse, skipped, hollow, figure),
+    };
+}
+/**
+ * The sentence reporting what a gesture picked out.
+ * @param copy - The words the map writes.
+ * @param count - How many samples are selected.
+ * @param total - How many there are in all.
+ * @returns The sentence.
+ */
+export function projectionSelectionSentence(copy, count, total) {
+    if (count === 0)
+        return copy.sentence.selectionNone;
+    return fillCopy(copy.sentence.selection, {
+        count: count.toLocaleString(),
+        total: total.toLocaleString(),
+    });
+}
+const NOT_OUTLINED_NOTE = 'Not outlined: too few samples.';
+const HOLLOW_LEGEND_LABEL = 'Hollow = added after the map was built';
+const HOLLOW_SENTENCE = 'The hollow dots were placed on the finished map afterwards, so one of them landing far out is a finding rather than a fault.';
+/**
+ * What the legend says when colour stands for nothing.
+ *
+ * The entries left are all shape, so the title names the shape channel: a
+ * legend naming no encoding at all is the one fault this title exists to
+ * prevent, and it is not fixed by leaving the title out.
+ */
+const SHAPE_LEGEND_TITLE = 'Shape = what each mark is.';
+function legendTitle(copy, groups, colored) {
+    if (!colored || groups.entries.length === 0)
+        return SHAPE_LEGEND_TITLE;
+    return fillCopy(copy.legend.mapNoEllipse, {
+        groups: groups.label.toLowerCase(),
+    });
+}
+function captionFor(copy, groups, colored, ellipse, skipped, hollow, figure) {
+    const solid = figure === 'space';
+    let sentence = solid ? copy.intro.space : copy.intro.map;
+    // What an outline actually holds is the one claim the figure makes that the
+    // reader cannot check by looking, so it is said in full here rather than
+    // squeezed onto the key floating over the dots.
+    if (colored && ellipse !== null) {
+        sentence += ` ${fillCopy(solid ? copy.legend.space : copy.legend.map, {
+            groups: groups.label.toLowerCase(),
+            coverage: solid
+                ? ellipsoidCoverageText(ellipse)
+                : ellipseCoverageText(ellipse),
+        })}`;
+    }
+    if (skipped.length > 0) {
+        const names = skipped.join(', ');
+        sentence += ` ${fillCopy(copy.sentence.skippedGroups, { names })}`;
+    }
+    if (hollow)
+        sentence += ` ${HOLLOW_SENTENCE}`;
+    return sentence;
+}
+function appendMarkerEntries(entries, markers, groups) {
+    const named = new Set();
+    for (const marker of markers) {
+        if (named.has(marker.label))
+            continue;
+        named.add(marker.label);
+        entries.push({
+            id: `marker-${marker.label}`,
+            label: marker.label,
+            color: groups.entries[marker.group ?? -1]?.color ?? UNGROUPED_INK,
+            shape: marker.shape ?? 'cross',
+        });
+    }
+}
+//# sourceMappingURL=projectionMapChrome.js.map

package/lib/projection/ui/projectionMapChrome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionMapChrome.js","sourceRoot":"","sources":["../../../src/projection/ui/projectionMapChrome.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAIrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAiDxD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAA+B;IAE/B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAC1E,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IACpE,MAAM,OAAO,GAAyB,EAAE,CAAC;IACzC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,OAAO,KAAK,IAAI,IAAI,KAAK,CAAC,KAAK,GAAG,aAAa,CAAC;YAC7D,IAAI,IAAI;gBAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpC,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;aAC3C,CAAC,CAAC;QACL,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,eAAe;gBACnB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK;gBACrC,KAAK,EAAE,aAAa;gBACpB,KAAK,EAAE,OAAO;aACf,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,WAAW,GAAG,KAAK,CAAC;IACnC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,CAAC,IAAI,CAAC;YACX,EAAE,EAAE,WAAW;YACf,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC;QACzC,OAAO;QACP,OAAO,EAAE,UAAU,CACjB,IAAI,EACJ,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,MAAM,EACN,MAAM,CACP;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CACzC,IAAoB,EACpB,KAAa,EACb,KAAa;IAEb,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;IACpD,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;QACvC,KAAK,EAAE,KAAK,CAAC,cAAc,EAAE;QAC7B,KAAK,EAAE,KAAK,CAAC,cAAc,EAAE;KAC9B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAC3D,MAAM,mBAAmB,GAAG,wCAAwC,CAAC;AACrE,MAAM,eAAe,GACnB,8HAA8H,CAAC;AAEjI;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,4BAA4B,CAAC;AAExD,SAAS,WAAW,CAClB,IAAoB,EACpB,MAAgC,EAChC,OAAgB;IAEhB,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,kBAAkB,CAAC;IACvE,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACxC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE;KACnC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CACjB,IAAoB,EACpB,MAAgC,EAChC,OAAgB,EAChB,OAA2B,EAC3B,OAA0B,EAC1B,MAAe,EACf,MAAuB;IAEvB,MAAM,KAAK,GAAG,MAAM,KAAK,OAAO,CAAC;IACjC,IAAI,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;IACzD,4EAA4E;IAC5E,yEAAyE;IACzE,gDAAgD;IAChD,IAAI,OAAO,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QAChC,QAAQ,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACpE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE;YAClC,QAAQ,EAAE,KAAK;gBACb,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC;gBAChC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC;SACjC,CAAC,EAAE,CAAC;IACP,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,QAAQ,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IACrE,CAAC;IACD,IAAI,MAAM;QAAE,QAAQ,IAAI,IAAI,eAAe,EAAE,CAAC;IAC9C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,mBAAmB,CAC1B,OAA6B,EAC7B,OAAoC,EACpC,MAAgC;IAEhC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,SAAS;QACtC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC;YACX,EAAE,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,aAAa;YACjE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,OAAO;SAC/B,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/lib/projection/ui/projectionMapModel.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Where a map's samples land, and which corner of the picture is free.
+ *
+ * It sits beside the component rather than inside it because a plot has to
+ * know where its dots fall before it can decide where its controls may sit,
+ * and because all of it is arithmetic that can be checked without rendering
+ * anything. The words the same tab writes are in `projectionMapChrome.ts`.
+ */
+import type { ChartViewport } from '../../chart/core/chartViewport.ts';
+import type { MatrixLike } from '../../chart/core/matrix.ts';
+import type { OverlayCorner } from '../../overlay/core/overlayPlacement.ts';
+import type { ScatterGroup, ScatterMarker } from '../../scatter/ui/ScatterPlot.tsx';
+import type { ProjectionMarker, ProjectionResult } from '../core/projectionResult.ts';
+import type { ResolvedProjectionGroups } from '../core/projectionSamples.ts';
+/** Where every sample sits on the map, in the embedding's own units. */
+export interface ProjectionMapCloud {
+    /** Horizontal coordinate of every sample, in row order. */
+    x: Float64Array;
+    /** Vertical coordinate of every sample, in the same order. */
+    y: Float64Array;
+}
+/**
+ * A dot, a marker or an average that stands for no group at all.
+ *
+ * It has to be the one ink on the map that names nothing, or a reader counts
+ * it as one more group.
+ */
+export declare const UNGROUPED_INK = "var(--text-faint)";
+/**
+ * How many samples a group needs before it is outlined at all. Below it the
+ * shape of the outline says more about the one sample than about the group.
+ */
+export declare const MINIMUM_OUTLINE_POINTS = 3;
+/**
+ * The two score columns the map draws, read out of the matrix once.
+ *
+ * The columns are copied because a plot takes two arrays and a matrix cannot
+ * hand out one of its columns. It is the only copy the tab makes: every range,
+ * every outline and every hit test afterwards reads the data where it stands.
+ * @param scores - Where every sample landed.
+ * @param xColumn - Which column runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @returns The two columns.
+ */
+export declare function projectionMapCloud(scores: MatrixLike, xColumn: number, yColumn: number): ProjectionMapCloud;
+/**
+ * The range one axis covers, over every sample or over a chosen few.
+ *
+ * Handing it a selection is what "zoom to selection" is: the same frame drawn
+ * around fewer rows, rather than a second transform layered under the first.
+ * @param scores - Where every sample landed.
+ * @param column - Which column the axis draws.
+ * @param rows - The rows to cover; an empty or absent list covers them all.
+ * @returns The range, as a frame takes it.
+ */
+export declare function projectionMapDomain(scores: MatrixLike, column: number, rows?: readonly number[]): readonly [number, number];
+/**
+ * The frame drawn around a chosen few samples, which is what "zoom to
+ * selection" hands the map.
+ *
+ * Room is left around them: a frame pulled tight on the outermost dots puts
+ * half of them on the edge of the picture, where a dot is hard to read and its
+ * name has nowhere to go.
+ * @param scores - Where every sample landed.
+ * @param xColumn - Which column runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @param rows - The rows to frame; an empty or absent list frames them all.
+ * @param padding - Share added at each end. Defaults to {@link SELECTION_ROOM}.
+ * @returns The frame, in the embedding's own units.
+ */
+export declare function projectionMapViewport(scores: MatrixLike, xColumn: number, yColumn: number, rows?: readonly number[], padding?: number): ChartViewport;
+/**
+ * The corner of the map with the fewest dots under it.
+ *
+ * All four are offered. The chrome that asks is laid out inside the plot
+ * rectangle rather than over the figure's box, so no corner of it costs the
+ * reader an axis label, and the only thing left to weigh is how many samples
+ * each one would cover.
+ * @param cloud - Where every sample sits, in data units.
+ * @param xDomain - The range the horizontal axis covers.
+ * @param yDomain - The range the vertical axis covers.
+ * @param width - Width of the plot rectangle, in pixels.
+ * @param height - Its height.
+ * @returns The corner the card sits in.
+ */
+export declare function projectionMapCorner(cloud: ProjectionMapCloud, xDomain: readonly [number, number], yDomain: readonly [number, number], width: number, height: number): OverlayCorner;
+/**
+ * The reference points of a result, placed on the two axes the map draws.
+ * @param markers - The reference points, in the embedding's own units.
+ * @param groups - The groups, whose colours the markers borrow.
+ * @param xColumn - Which axis runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @returns The markers a plot can draw; one standing off the two axes drawn is left out.
+ */
+export declare function projectionMapMarkers(markers: readonly ProjectionMarker[], groups: ResolvedProjectionGroups, xColumn: number, yColumn: number): ScatterMarker[];
+/**
+ * The groups in the shape a plot colours by.
+ * @param groups - The groups as the viewer resolved them.
+ * @returns One entry per group, in the order they are coloured.
+ */
+export declare function projectionScatterGroups(groups: ResolvedProjectionGroups): ScatterGroup[];
+/**
+ * What one axis of the map is called.
+ *
+ * Built by `chartAxisTitle` rather than assembled here, so a component reads
+ * `PC1 — 73.0 %` in exactly the form every other figure in the package writes
+ * it, and a method that publishes no share gets a bare name instead of a
+ * percentage nobody can stand behind.
+ * @param result - The reduced space being drawn.
+ * @param index - Which axis.
+ * @returns The title, or `undefined` for an axis the result does not have.
+ */
+export declare function projectionAxisTitle(result: ProjectionResult, index: number): string | undefined;
+//# sourceMappingURL=projectionMapModel.d.ts.map

package/lib/projection/ui/projectionMapModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionMapModel.d.ts","sourceRoot":"","sources":["../../../src/projection/ui/projectionMapModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAE7E,wEAAwE;AACxE,MAAM,WAAW,kBAAkB;IACjC,2DAA2D;IAC3D,CAAC,EAAE,YAAY,CAAC;IAChB,8DAA8D;IAC9D,CAAC,EAAE,YAAY,CAAC;CACjB;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAsB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,kBAAkB,CASpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,GACvB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAI3B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,EACxB,OAAO,SAAiB,GACvB,aAAa,CAKf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,kBAAkB,EACzB,OAAO,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,OAAO,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,aAAa,CAMf;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,SAAS,gBAAgB,EAAE,EACpC,MAAM,EAAE,wBAAwB,EAChC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,aAAa,EAAE,CAejB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,wBAAwB,GAC/B,YAAY,EAAE,CAMhB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,gBAAgB,EACxB,KAAK,EAAE,MAAM,GACZ,MAAM,GAAG,SAAS,CAIpB"}

package/lib/projection/ui/projectionMapModel.js

@@ -0,0 +1,177 @@
+/**
+ * Where a map's samples land, and which corner of the picture is free.
+ *
+ * It sits beside the component rather than inside it because a plot has to
+ * know where its dots fall before it can decide where its controls may sit,
+ * and because all of it is arithmetic that can be checked without rendering
+ * anything. The words the same tab writes are in `projectionMapChrome.ts`.
+ */
+import { chartColumnExtent, chartPadExtent, } from "../../chart/core/chartExtent.js";
+import { chartAxisTitle } from "../../chart/core/chartLabels.js";
+import { emptiestCorner } from "../../overlay/core/emptiestCorner.js";
+/**
+ * A dot, a marker or an average that stands for no group at all.
+ *
+ * It has to be the one ink on the map that names nothing, or a reader counts
+ * it as one more group.
+ */
+export const UNGROUPED_INK = 'var(--text-faint)';
+/**
+ * How many samples a group needs before it is outlined at all. Below it the
+ * shape of the outline says more about the one sample than about the group.
+ */
+export const MINIMUM_OUTLINE_POINTS = 3;
+/**
+ * The two score columns the map draws, read out of the matrix once.
+ *
+ * The columns are copied because a plot takes two arrays and a matrix cannot
+ * hand out one of its columns. It is the only copy the tab makes: every range,
+ * every outline and every hit test afterwards reads the data where it stands.
+ * @param scores - Where every sample landed.
+ * @param xColumn - Which column runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @returns The two columns.
+ */
+export function projectionMapCloud(scores, xColumn, yColumn) {
+    const count = Math.max(0, scores.rows);
+    const x = new Float64Array(count);
+    const y = new Float64Array(count);
+    for (let row = 0; row < count; row++) {
+        x[row] = scores.get(row, xColumn);
+        y[row] = scores.get(row, yColumn);
+    }
+    return { x, y };
+}
+/**
+ * The range one axis covers, over every sample or over a chosen few.
+ *
+ * Handing it a selection is what "zoom to selection" is: the same frame drawn
+ * around fewer rows, rather than a second transform layered under the first.
+ * @param scores - Where every sample landed.
+ * @param column - Which column the axis draws.
+ * @param rows - The rows to cover; an empty or absent list covers them all.
+ * @returns The range, as a frame takes it.
+ */
+export function projectionMapDomain(scores, column, rows) {
+    const covered = rows === undefined || rows.length === 0 ? undefined : rows;
+    const extent = chartColumnExtent(scores, column, { indices: covered });
+    return [extent.min, extent.max];
+}
+/**
+ * The frame drawn around a chosen few samples, which is what "zoom to
+ * selection" hands the map.
+ *
+ * Room is left around them: a frame pulled tight on the outermost dots puts
+ * half of them on the edge of the picture, where a dot is hard to read and its
+ * name has nowhere to go.
+ * @param scores - Where every sample landed.
+ * @param xColumn - Which column runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @param rows - The rows to frame; an empty or absent list frames them all.
+ * @param padding - Share added at each end. Defaults to {@link SELECTION_ROOM}.
+ * @returns The frame, in the embedding's own units.
+ */
+export function projectionMapViewport(scores, xColumn, yColumn, rows, padding = SELECTION_ROOM) {
+    return {
+        x: withRoom(projectionMapDomain(scores, xColumn, rows), padding),
+        y: withRoom(projectionMapDomain(scores, yColumn, rows), padding),
+    };
+}
+/**
+ * The corner of the map with the fewest dots under it.
+ *
+ * All four are offered. The chrome that asks is laid out inside the plot
+ * rectangle rather than over the figure's box, so no corner of it costs the
+ * reader an axis label, and the only thing left to weigh is how many samples
+ * each one would cover.
+ * @param cloud - Where every sample sits, in data units.
+ * @param xDomain - The range the horizontal axis covers.
+ * @param yDomain - The range the vertical axis covers.
+ * @param width - Width of the plot rectangle, in pixels.
+ * @param height - Its height.
+ * @returns The corner the card sits in.
+ */
+export function projectionMapCorner(cloud, xDomain, yDomain, width, height) {
+    return emptiestCorner(placeAlong(cloud.x, xDomain, width, false), placeAlong(cloud.y, yDomain, height, true), { width, height, cardWidth: CARD_WIDTH, cardHeight: CARD_HEIGHT });
+}
+/**
+ * The reference points of a result, placed on the two axes the map draws.
+ * @param markers - The reference points, in the embedding's own units.
+ * @param groups - The groups, whose colours the markers borrow.
+ * @param xColumn - Which axis runs left to right.
+ * @param yColumn - Which one runs bottom to top.
+ * @returns The markers a plot can draw; one standing off the two axes drawn is left out.
+ */
+export function projectionMapMarkers(markers, groups, xColumn, yColumn) {
+    const placed = [];
+    for (const marker of markers) {
+        const x = marker.position[xColumn];
+        const y = marker.position[yColumn];
+        if (x === undefined || y === undefined)
+            continue;
+        placed.push({
+            label: marker.label,
+            x,
+            y,
+            color: groups.entries[marker.group ?? -1]?.color ?? UNGROUPED_INK,
+            shape: marker.shape ?? 'cross',
+        });
+    }
+    return placed;
+}
+/**
+ * The groups in the shape a plot colours by.
+ * @param groups - The groups as the viewer resolved them.
+ * @returns One entry per group, in the order they are coloured.
+ */
+export function projectionScatterGroups(groups) {
+    const plotted = [];
+    for (const entry of groups.entries) {
+        plotted.push({ id: entry.id, label: entry.label, color: entry.color });
+    }
+    return plotted;
+}
+/**
+ * What one axis of the map is called.
+ *
+ * Built by `chartAxisTitle` rather than assembled here, so a component reads
+ * `PC1 — 73.0 %` in exactly the form every other figure in the package writes
+ * it, and a method that publishes no share gets a bare name instead of a
+ * percentage nobody can stand behind.
+ * @param result - The reduced space being drawn.
+ * @param index - Which axis.
+ * @returns The title, or `undefined` for an axis the result does not have.
+ */
+export function projectionAxisTitle(result, index) {
+    const axis = result.axes[index];
+    if (axis === undefined)
+        return undefined;
+    return chartAxisTitle(axis.name, { share: axis.share });
+}
+function withRoom(domain, padding) {
+    const extent = chartPadExtent({ min: domain[0], max: domain[1] }, padding);
+    return [extent.min, extent.max];
+}
+function placeAlong(values, domain, size, flip) {
+    const span = domain[1] - domain[0];
+    const factor = span === 0 ? 0 : size / span;
+    const pixels = new Float64Array(values.length);
+    for (let index = 0; index < values.length; index++) {
+        const along = ((values[index] ?? Number.NaN) - domain[0]) * factor;
+        pixels[index] = flip ? size - along : along;
+    }
+    return pixels;
+}
+/**
+ * How much of the plot the floating key is expected to cover.
+ *
+ * It is an estimate on purpose — the card has not been laid out when the
+ * corner is chosen — and it is the compact key's size rather than the roomier
+ * card the overlay domain assumes: a corner counted as three species wide
+ * would call a corner busy that the key never reaches.
+ */
+const CARD_WIDTH = 170;
+const CARD_HEIGHT = 84;
+/** Room left around a framed selection, as a share of its own span. */
+const SELECTION_ROOM = 0.1;
+//# sourceMappingURL=projectionMapModel.js.map

package/lib/projection/ui/projectionMapModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionMapModel.js","sourceRoot":"","sources":["../../../src/projection/ui/projectionMapModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,iBAAiB,EACjB,cAAc,GACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAGjE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAoBtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAExC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAkB,EAClB,OAAe,EACf,OAAe;IAEf,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;QACrC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAkB,EAClB,MAAc,EACd,IAAwB;IAExB,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAkB,EAClB,OAAe,EACf,OAAe,EACf,IAAwB,EACxB,OAAO,GAAG,cAAc;IAExB,OAAO;QACL,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAChE,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;KACjE,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAyB,EACzB,OAAkC,EAClC,OAAkC,EAClC,KAAa,EACb,MAAc;IAEd,OAAO,cAAc,CACnB,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,EAC1C,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAC1C,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAoC,EACpC,MAAgC,EAChC,OAAe,EACf,OAAe;IAEf,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QACjD,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,CAAC;YACD,CAAC;YACD,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,aAAa;YACjE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,OAAO;SAC/B,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAgC;IAEhC,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAwB,EACxB,KAAa;IAEb,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,QAAQ,CACf,MAAiC,EACjC,OAAe;IAEf,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,UAAU,CACjB,MAAoB,EACpB,MAAiC,EACjC,IAAY,EACZ,IAAa;IAEb,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;IAC5C,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;QACnE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,uEAAuE;AACvE,MAAM,cAAc,GAAG,GAAG,CAAC"}

package/lib/projection/ui/projectionMapView.d.ts

@@ -0,0 +1,72 @@
+/**
+ * What the map is showing that is not an option: the frame it is drawn in, the
+ * sentence reporting the last gesture, and the words its key and its question
+ * mark are built from.
+ *
+ * All of it lives above the tab rather than inside it because the bar spanning
+ * the figure is the viewer's, not the map's: "Zoom to selection" is pressed in
+ * the bar and changes the frame the map draws, and "Clear selection" has to
+ * report itself in exactly the words a released lasso does.
+ */
+import type { ChartViewport } from '../../chart/core/chartViewport.ts';
+import type { SelectionChange } from '../../scatter/ui/useScatterSelection.ts';
+import type { OrbitCamera } from '../../scatter3d/core/orbitCamera.ts';
+import type { ProjectionCopy } from '../core/projectionCopy.ts';
+import type { ProjectionOptions } from '../core/projectionOptions.ts';
+import type { ProjectionResult } from '../core/projectionResult.ts';
+import type { ResolvedProjectionGroups } from '../core/projectionSamples.ts';
+import type { SelectionReport } from './ProjectionMapCaption.tsx';
+import type { ProjectionMapChrome } from './projectionMapChrome.ts';
+/** What {@link useProjectionMapView} needs. */
+export interface ProjectionMapViewInput {
+    /** What the run produced, whatever produced it. */
+    result: ProjectionResult;
+    /** The words the viewer writes, already merged over the defaults. */
+    copy: ProjectionCopy;
+    /** The groups as every figure of this viewer draws them. */
+    groups: ResolvedProjectionGroups;
+    /** Every option, already made safe against the result. */
+    options: ProjectionOptions;
+    /** The selected rows, as indices into the score matrix. */
+    selected: readonly number[];
+    /** Settle a selection, whoever caused it. */
+    onSettle: (change: SelectionChange) => void;
+}
+/** The map's own state, and the ways a gesture or a button changes it. */
+export interface ProjectionMapView {
+    /** The key's title, the key's entries, and the paragraph behind the `?`. */
+    chrome: ProjectionMapChrome;
+    /** The same three for the cloud, which promises a different share. */
+    spaceChrome: ProjectionMapChrome;
+    /** Where the reader is standing in the cloud. */
+    camera: OrbitCamera;
+    /** Turn the box. */
+    setCamera: (camera: OrbitCamera) => void;
+    /** How far in the cloud is zoomed. */
+    zoom: number;
+    /** Zoom the box. */
+    setZoom: (zoom: number) => void;
+    /** Put the box back where it was first seen, at the size it was first drawn. */
+    resetSpaceView: () => void;
+    /** The frame the map is drawn in, or `null` when it is drawn around every sample. */
+    viewport: ChartViewport | null;
+    /** Draw the map in another frame, which is what the wheel does. */
+    setViewport: (viewport: ChartViewport | null) => void;
+    /** What the last gesture picked out, or `null` before there was one. */
+    report: SelectionReport | null;
+    /** Settle a selection and report it in the same breath. */
+    settle: (change: SelectionChange) => void;
+    /** Draw the frame around the selected samples. */
+    zoomToSelection: () => void;
+    /** Put the frame back around every sample. */
+    resetView: () => void;
+    /** Empty the selection. */
+    clearSelection: () => void;
+}
+/**
+ * The map's frame, its last report, and the words around it.
+ * @param input - See {@link ProjectionMapViewInput}.
+ * @returns See {@link ProjectionMapView}.
+ */
+export declare function useProjectionMapView(input: ProjectionMapViewInput): ProjectionMapView;
+//# sourceMappingURL=projectionMapView.d.ts.map

package/lib/projection/ui/projectionMapView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectionMapView.d.ts","sourceRoot":"","sources":["../../../src/projection/ui/projectionMapView.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAEvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAE7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAYpE,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,MAAM,EAAE,gBAAgB,CAAC;IACzB,qEAAqE;IACrE,IAAI,EAAE,cAAc,CAAC;IACrB,4DAA4D;IAC5D,MAAM,EAAE,wBAAwB,CAAC;IACjC,0DAA0D;IAC1D,OAAO,EAAE,iBAAiB,CAAC;IAC3B,2DAA2D;IAC3D,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,6CAA6C;IAC7C,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;CAC7C;AAED,0EAA0E;AAC1E,MAAM,WAAW,iBAAiB;IAChC,4EAA4E;IAC5E,MAAM,EAAE,mBAAmB,CAAC;IAC5B,sEAAsE;IACtE,WAAW,EAAE,mBAAmB,CAAC;IACjC,iDAAiD;IACjD,MAAM,EAAE,WAAW,CAAC;IACpB,oBAAoB;IACpB,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IACzC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,gFAAgF;IAChF,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,qFAAqF;IACrF,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAC/B,mEAAmE;IACnE,WAAW,EAAE,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,KAAK,IAAI,CAAC;IACtD,wEAAwE;IACxE,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,2DAA2D;IAC3D,MAAM,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;IAC1C,kDAAkD;IAClD,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,2BAA2B;IAC3B,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,sBAAsB,GAC5B,iBAAiB,CA6HnB"}