react-cheminfo 0.28.0 → 0.29.0

package/lib/ir/core/irBand.d.ts

@@ -0,0 +1,45 @@
+/**
+ * One band picked out of a spectrum.
+ *
+ * A band is the infrared analogue of a mass spectrum's peak: the thing a chemist
+ * points at, names, and reads a functional group off. It carries both value axes
+ * for the same reason the spectrum does — the band a reader sees at 30 percent
+ * transmittance and the one a table calls strongly absorbing are one band, and
+ * making the caller convert to find out would be the conversion this package
+ * does not do.
+ */
+/**
+ * How strong a band is, in the letters a correlation table uses.
+ *
+ * `w` weak, `m` medium, `S` strong — `ir-spectrum` decides which from where the
+ * band sits between the spectrum's own extremes, so the letters are relative to
+ * the spectrum in hand rather than to an absolute absorbance. That is what a
+ * printed table means by them too.
+ */
+export type IrBandStrength = 'w' | 'm' | 'S';
+/** One band picked out of one spectrum. */
+export interface IrBand {
+    /** Identity of the spectrum it was picked from. */
+    spectrumId: string;
+    /** Where it sits, in cm⁻¹. */
+    wavenumber: number;
+    /** Its absorbance, which is what it was picked as a maximum of. */
+    absorbance: number;
+    /** Its percent transmittance, the same band read the other way up. */
+    transmittance: number;
+    /** How strong it is, relative to the spectrum it came from. */
+    strength: IrBandStrength;
+}
+/**
+ * Whether two bands are the same band.
+ *
+ * The wavenumber is compared exactly, and that is not an oversight: both numbers
+ * were read out of the same picked band, so either they are the very same
+ * measurement or they are two different bands. A tolerance here would declare a
+ * carbonyl pair thirty wavenumbers apart to be one band.
+ * @param current - What was last reported.
+ * @param next - What would be reported now.
+ * @returns Whether the report can be skipped.
+ */
+export declare function sameIrBand(current: IrBand | null, next: IrBand | null): boolean;
+//# sourceMappingURL=irBand.d.ts.map

package/lib/ir/core/irBand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irBand.d.ts","sourceRoot":"","sources":["../../../src/ir/core/irBand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE7C,2CAA2C;AAC3C,MAAM,WAAW,MAAM;IACrB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,sEAAsE;IACtE,aAAa,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAClB,OAAO,CAOT"}

package/lib/ir/core/irBand.js

@@ -0,0 +1,30 @@
+/**
+ * One band picked out of a spectrum.
+ *
+ * A band is the infrared analogue of a mass spectrum's peak: the thing a chemist
+ * points at, names, and reads a functional group off. It carries both value axes
+ * for the same reason the spectrum does — the band a reader sees at 30 percent
+ * transmittance and the one a table calls strongly absorbing are one band, and
+ * making the caller convert to find out would be the conversion this package
+ * does not do.
+ */
+/**
+ * Whether two bands are the same band.
+ *
+ * The wavenumber is compared exactly, and that is not an oversight: both numbers
+ * were read out of the same picked band, so either they are the very same
+ * measurement or they are two different bands. A tolerance here would declare a
+ * carbonyl pair thirty wavenumbers apart to be one band.
+ * @param current - What was last reported.
+ * @param next - What would be reported now.
+ * @returns Whether the report can be skipped.
+ */
+export function sameIrBand(current, next) {
+    if (current === next)
+        return true;
+    if (current === null || next === null)
+        return false;
+    return (current.spectrumId === next.spectrumId &&
+        current.wavenumber === next.wavenumber);
+}
+//# sourceMappingURL=irBand.js.map

package/lib/ir/core/irBand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irBand.js","sourceRoot":"","sources":["../../../src/ir/core/irBand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AA0BH;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAsB,EACtB,IAAmB;IAEnB,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACpD,OAAO,CACL,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;QACtC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU,CACvC,CAAC;AACJ,CAAC"}

package/lib/ir/core/irCommands.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Everything the viewer offers, what each is called, and the key it answers to.
+ *
+ * One table, read by three things that must agree: the toolbar draws it, the
+ * tooltip explains it, and the key handler fires it. Written apart from all
+ * three so a command cannot be added to the toolbar without a name, or bound to
+ * a key nothing tells the reader about.
+ *
+ * The provider, the hooks and the tooltip are three files of their own beside
+ * this one, because a module that exports a component and a constant together
+ * cannot be hot reloaded — `react-refresh/only-export-components` is the rule
+ * that says so, and the split is the fix rather than the exception.
+ */
+/** The key a command answers to. */
+export interface IrShortcut {
+    /** The `event.key` values it fires on, the first being the one shown. */
+    keys: readonly string[];
+    /**
+     * How to write the key in a tooltip, where the raw value would read badly.
+     * @default the first of `keys`
+     */
+    label?: readonly string[];
+}
+/** A gesture that does the same thing, listed under the tooltip's title. */
+export interface IrGesture {
+    /** Where the gesture is made, or what it is made with. */
+    title: string;
+    /** The buttons, keys or wheel that make it. */
+    shortcuts: readonly string[];
+}
+/** One thing the viewer can be asked to do. */
+export interface IrCommand {
+    /** What it is called, which is what the tooltip is titled. */
+    title: string;
+    /**
+     * The key it answers to, absent for a command with none.
+     * @default undefined
+     */
+    shortcut?: IrShortcut;
+    /**
+     * What it does, in a sentence, under the title in the tooltip.
+     * @default undefined
+     */
+    description?: string;
+    /**
+     * The gestures that do the same thing, for the ones a key cannot describe.
+     * @default undefined
+     */
+    gestures?: readonly IrGesture[];
+}
+/** Everything the viewer offers, in the order it is reached for. */
+export declare const irCommands: {
+    readonly about: {
+        readonly title: "About the infrared viewer";
+        readonly description: "What it reads, what it is built on, and what it credits.";
+    };
+    readonly documentation: {
+        readonly title: "Documentation";
+        readonly shortcut: {
+            readonly keys: readonly ["h"];
+        };
+        readonly description: "How to open a spectrum, what the panels hold, and every gesture.";
+    };
+    readonly fullScreen: {
+        readonly title: "Full screen";
+        readonly description: "The viewer takes the whole screen rather than its corner of the page. Esc gives it back.";
+    };
+    readonly readTool: {
+        readonly title: "Read";
+        readonly shortcut: {
+            readonly keys: readonly ["r"];
+        };
+        readonly description: "A drag narrows the wavenumber axis, which is the question a spectrum is nearly always asked. Released past the baseline it takes the value axis with it. Reading absorbance only: percent transmittance is zoomed by rectangle alone.";
+        readonly gestures: readonly [{
+            readonly title: "Reading absorbance";
+            readonly shortcuts: readonly ["Drag"];
+        }];
+    };
+    readonly boxTool: {
+        readonly title: "Square zoom";
+        readonly shortcut: {
+            readonly keys: readonly ["b"];
+        };
+        readonly description: "A drag zooms to exactly the rectangle it sweeps out, both axes at once — for looking into a baseline or a shoulder rather than across the spectrum. It is the only drag on percent transmittance.";
+        readonly gestures: readonly [{
+            readonly title: "Over the chart";
+            readonly shortcuts: readonly ["Drag a rectangle"];
+        }];
+    };
+    readonly zoomIn: {
+        readonly title: "Zoom in";
+        readonly shortcut: {
+            readonly keys: readonly ["+", "="];
+        };
+        readonly description: "Brings the weak bands up, about the baseline they hang from.";
+        readonly gestures: readonly [{
+            readonly title: "Reading absorbance";
+            readonly shortcuts: readonly ["Scroll wheel"];
+        }];
+    };
+    readonly zoomOut: {
+        readonly title: "Zoom out";
+        readonly shortcut: {
+            readonly keys: readonly ["-"];
+        };
+        readonly description: "Puts the value axis back out again.";
+        readonly gestures: readonly [{
+            readonly title: "Reading absorbance";
+            readonly shortcuts: readonly ["Scroll wheel"];
+        }];
+    };
+    readonly resetZoom: {
+        readonly title: "Zoom to fit";
+        readonly shortcut: {
+            readonly keys: readonly ["f"];
+        };
+        readonly description: "Shows every spectrum that is drawn, whole.";
+        readonly gestures: readonly [{
+            readonly title: "Over the chart";
+            readonly shortcuts: readonly ["Double click"];
+        }];
+    };
+    readonly toggleMode: {
+        readonly title: "Absorbance or transmittance";
+        readonly shortcut: {
+            readonly keys: readonly ["t"];
+        };
+        readonly description: "The same measurement read the other way up. Bands hang down from 100 % transmittance and stand up out of zero absorbance.";
+    };
+    readonly togglePicking: {
+        readonly title: "Pick the bands";
+        readonly shortcut: {
+            readonly keys: readonly ["p"];
+        };
+        readonly description: "Finds the bands of the selected spectrum, marks them on the chart and lists them with everything each might be.";
+    };
+    readonly toggleAssignments: {
+        readonly title: "Name the assignments";
+        readonly shortcut: {
+            readonly keys: readonly ["a"];
+        };
+        readonly description: "Writes what each labelled band might be under its wavenumber. Worth turning off once the chart is crowded.";
+    };
+    readonly exportImage: {
+        readonly title: "Export as an image…";
+        readonly shortcut: {
+            readonly keys: readonly ["x"];
+        };
+        readonly description: "The chart as it stands, at a chosen resolution — PNG, or SVG, which is drawn again at whatever size it is printed rather than enlarged.";
+    };
+    readonly clear: {
+        readonly title: "Close every spectrum";
+        readonly description: "Empties the chart and starts again.";
+    };
+};
+/** Identity of one of the commands the viewer offers. */
+export type IrCommandId = keyof typeof irCommands;
+/** What to do when each command is run, as the shell wires them. */
+export type IrCommandHandlers = Partial<Record<IrCommandId, (() => void) | undefined>>;
+/** How a component runs a command. */
+export type RunIrCommand = (id: IrCommandId) => void;
+/**
+ * What a command is called, with its key, for a label and an `aria-label`.
+ * @param id - Which command.
+ * @returns The title, and the key in parentheses when it has one.
+ */
+export declare function irCommandLabel(id: IrCommandId): string;
+//# sourceMappingURL=irCommands.d.ts.map

package/lib/ir/core/irCommands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irCommands.d.ts","sourceRoot":"","sources":["../../../src/ir/core/irCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,oCAAoC;AACpC,MAAM,WAAW,UAAU;IACzB,yEAAyE;IACzE,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B;AAED,4EAA4E;AAC5E,MAAM,WAAW,SAAS;IACxB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B;AAED,+CAA+C;AAC/C,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC;CACjC;AAED,oEAAoE;AACpE,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4EuB,CAAC;AAE/C,yDAAyD;AACzD,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,UAAU,CAAC;AAElD,oEAAoE;AACpE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,MAAM,CAAC,WAAW,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC,CAC9C,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,WAAW,KAAK,IAAI,CAAC;AAErD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM,CAItD"}

package/lib/ir/core/irCommands.js

@@ -0,0 +1,94 @@
+/**
+ * Everything the viewer offers, what each is called, and the key it answers to.
+ *
+ * One table, read by three things that must agree: the toolbar draws it, the
+ * tooltip explains it, and the key handler fires it. Written apart from all
+ * three so a command cannot be added to the toolbar without a name, or bound to
+ * a key nothing tells the reader about.
+ *
+ * The provider, the hooks and the tooltip are three files of their own beside
+ * this one, because a module that exports a component and a constant together
+ * cannot be hot reloaded — `react-refresh/only-export-components` is the rule
+ * that says so, and the split is the fix rather than the exception.
+ */
+/** Everything the viewer offers, in the order it is reached for. */
+export const irCommands = {
+    about: {
+        title: 'About the infrared viewer',
+        description: 'What it reads, what it is built on, and what it credits.',
+    },
+    documentation: {
+        title: 'Documentation',
+        shortcut: { keys: ['h'] },
+        description: 'How to open a spectrum, what the panels hold, and every gesture.',
+    },
+    fullScreen: {
+        title: 'Full screen',
+        description: 'The viewer takes the whole screen rather than its corner of the page. Esc gives it back.',
+    },
+    readTool: {
+        title: 'Read',
+        shortcut: { keys: ['r'] },
+        description: 'A drag narrows the wavenumber axis, which is the question a spectrum is nearly always asked. Released past the baseline it takes the value axis with it. Reading absorbance only: percent transmittance is zoomed by rectangle alone.',
+        gestures: [{ title: 'Reading absorbance', shortcuts: ['Drag'] }],
+    },
+    boxTool: {
+        title: 'Square zoom',
+        shortcut: { keys: ['b'] },
+        description: 'A drag zooms to exactly the rectangle it sweeps out, both axes at once — for looking into a baseline or a shoulder rather than across the spectrum. It is the only drag on percent transmittance.',
+        gestures: [{ title: 'Over the chart', shortcuts: ['Drag a rectangle'] }],
+    },
+    zoomIn: {
+        title: 'Zoom in',
+        shortcut: { keys: ['+', '='] },
+        description: 'Brings the weak bands up, about the baseline they hang from.',
+        gestures: [{ title: 'Reading absorbance', shortcuts: ['Scroll wheel'] }],
+    },
+    zoomOut: {
+        title: 'Zoom out',
+        shortcut: { keys: ['-'] },
+        description: 'Puts the value axis back out again.',
+        gestures: [{ title: 'Reading absorbance', shortcuts: ['Scroll wheel'] }],
+    },
+    resetZoom: {
+        title: 'Zoom to fit',
+        shortcut: { keys: ['f'] },
+        description: 'Shows every spectrum that is drawn, whole.',
+        gestures: [{ title: 'Over the chart', shortcuts: ['Double click'] }],
+    },
+    toggleMode: {
+        title: 'Absorbance or transmittance',
+        shortcut: { keys: ['t'] },
+        description: 'The same measurement read the other way up. Bands hang down from 100 % transmittance and stand up out of zero absorbance.',
+    },
+    togglePicking: {
+        title: 'Pick the bands',
+        shortcut: { keys: ['p'] },
+        description: 'Finds the bands of the selected spectrum, marks them on the chart and lists them with everything each might be.',
+    },
+    toggleAssignments: {
+        title: 'Name the assignments',
+        shortcut: { keys: ['a'] },
+        description: 'Writes what each labelled band might be under its wavenumber. Worth turning off once the chart is crowded.',
+    },
+    exportImage: {
+        title: 'Export as an image…',
+        shortcut: { keys: ['x'] },
+        description: 'The chart as it stands, at a chosen resolution — PNG, or SVG, which is drawn again at whatever size it is printed rather than enlarged.',
+    },
+    clear: {
+        title: 'Close every spectrum',
+        description: 'Empties the chart and starts again.',
+    },
+};
+/**
+ * What a command is called, with its key, for a label and an `aria-label`.
+ * @param id - Which command.
+ * @returns The title, and the key in parentheses when it has one.
+ */
+export function irCommandLabel(id) {
+    const entry = irCommands[id];
+    const key = entry.shortcut?.label?.[0] ?? entry.shortcut?.keys[0];
+    return key === undefined ? entry.title : `${entry.title} (${key})`;
+}
+//# sourceMappingURL=irCommands.js.map

package/lib/ir/core/irCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irCommands.js","sourceRoot":"","sources":["../../../src/ir/core/irCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AA0CH,oEAAoE;AACpE,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,KAAK,EAAE;QACL,KAAK,EAAE,2BAA2B;QAClC,WAAW,EAAE,0DAA0D;KACxE;IACD,aAAa,EAAE;QACb,KAAK,EAAE,eAAe;QACtB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,kEAAkE;KACrE;IACD,UAAU,EAAE;QACV,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,0FAA0F;KAC7F;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,uOAAuO;QACzO,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;KACjE;IACD,OAAO,EAAE;QACP,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,mMAAmM;QACrM,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC;KACzE;IACD,MAAM,EAAE;QACN,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;QAC9B,WAAW,EAAE,8DAA8D;QAC3E,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;KACzE;IACD,OAAO,EAAE;QACP,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;KACzE;IACD,SAAS,EAAE;QACT,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EAAE,4CAA4C;QACzD,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;KACrE;IACD,UAAU,EAAE;QACV,KAAK,EAAE,6BAA6B;QACpC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,2HAA2H;KAC9H;IACD,aAAa,EAAE;QACb,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,iHAAiH;KACpH;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,sBAAsB;QAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,4GAA4G;KAC/G;IACD,WAAW,EAAE;QACX,KAAK,EAAE,qBAAqB;QAC5B,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;QACzB,WAAW,EACT,yIAAyI;KAC5I;IACD,KAAK,EAAE;QACL,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EAAE,qCAAqC;KACnD;CAC2C,CAAC;AAa/C;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,EAAe;IAC5C,MAAM,KAAK,GAAG,UAAU,CAAC,EAAE,CAAc,CAAC;IAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAClE,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,KAAK,GAAG,GAAG,CAAC;AACrE,CAAC"}

package/lib/ir/core/irDomain.d.ts

@@ -0,0 +1,63 @@
+/**
+ * The window a chart opens on, worked out from the spectra it was handed.
+ *
+ * This is what "zoom to fit" and the first render both call, so it has to answer
+ * something usable when it is handed nothing at all — a chart with no data is
+ * still mounted, still measured, and still builds its scales.
+ *
+ * The x window is in ascending wavenumbers even though the axis is drawn from
+ * 4000 down to 400: which way round it is read is the chart's business, and
+ * every piece of arithmetic that moves a window expects its ends in order.
+ */
+import type { IrDomain, IrMode, IrSpectrum } from './irSpectrum.ts';
+/**
+ * How much air is left either side of the outermost point, as a fraction.
+ *
+ * A trace drawn hard against the axis reads as a spectrum that was cut off
+ * there; two percent is enough to show that it was not.
+ */
+export declare const X_DOMAIN_PADDING = 0.02;
+/** The same, on the value axis, where a trace touching an edge reads the same. */
+export declare const Y_DOMAIN_PADDING = 0.05;
+/**
+ * The extra room kept on the side the band labels occupy, as a fraction.
+ *
+ * A named band carries its wavenumber and its assignment on two lines, stacked
+ * away from the baseline — upwards from an absorbance maximum, downwards from a
+ * transmittance minimum — so the room has to be on a different side in each
+ * mode. Twenty percent is what those two lines take on a chart of any usual
+ * height.
+ */
+export declare const LABEL_HEADROOM = 0.2;
+/**
+ * The window that shows everything currently drawn.
+ *
+ * A spectrum marked `excludeFromDomain` is left out of the extents, because it
+ * is a reference held up for comparison rather than data: letting it move the
+ * axes would throw away the zoom the user set every time they held one up. The
+ * exclusion is dropped when it would leave nothing at all.
+ * @param spectra - Everything the chart holds, drawn or not.
+ * @param mode - Which value axis is being drawn, which decides both the extents
+ * and the side the label room is kept on.
+ * @returns The window, in wavenumbers and in the value axis.
+ */
+export declare function fullDomain(spectra: readonly IrSpectrum[], mode: IrMode): IrDomain;
+/**
+ * What a fitted window was fitted *to*, as one string two renders can compare.
+ *
+ * The chart puts its window back to `fullDomain` when it is handed different
+ * data, and must not when the same data is merely redrawn — so something has to
+ * tell the two apart.
+ *
+ * **The mode is part of it**, and that is the one place this differs from a mass
+ * spectrum's fit key. Switching from transmittance to absorbance does not nudge
+ * the extents, it replaces the value axis outright — a window of 25 to 100
+ * percent means nothing at all in absorbance — so it has to refit, where a
+ * change of colour or of name must not.
+ * @param spectra - Everything the chart holds, drawn or not.
+ * @param mode - Which value axis is being drawn.
+ * @returns A string equal to itself exactly when a fit would be made to the
+ * same thing.
+ */
+export declare function fittedTo(spectra: readonly IrSpectrum[], mode: IrMode): string;
+//# sourceMappingURL=irDomain.d.ts.map

package/lib/ir/core/irDomain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irDomain.d.ts","sourceRoot":"","sources":["../../../src/ir/core/irDomain.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAGpE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC,kFAAkF;AAClF,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,IAAI,EAAE,MAAM,GACX,QAAQ,CA0BV;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAO7E"}

package/lib/ir/core/irDomain.js

@@ -0,0 +1,136 @@
+/**
+ * The window a chart opens on, worked out from the spectra it was handed.
+ *
+ * This is what "zoom to fit" and the first render both call, so it has to answer
+ * something usable when it is handed nothing at all — a chart with no data is
+ * still mounted, still measured, and still builds its scales.
+ *
+ * The x window is in ascending wavenumbers even though the axis is drawn from
+ * 4000 down to 400: which way round it is read is the chart's business, and
+ * every piece of arithmetic that moves a window expects its ends in order.
+ */
+import { xMaxValue, xMinValue } from 'ml-spectra-processing';
+import { bandsPointDown } from "./irMode.js";
+import { traceOf } from "./irSpectrum.js";
+/**
+ * How much air is left either side of the outermost point, as a fraction.
+ *
+ * A trace drawn hard against the axis reads as a spectrum that was cut off
+ * there; two percent is enough to show that it was not.
+ */
+export const X_DOMAIN_PADDING = 0.02;
+/** The same, on the value axis, where a trace touching an edge reads the same. */
+export const Y_DOMAIN_PADDING = 0.05;
+/**
+ * The extra room kept on the side the band labels occupy, as a fraction.
+ *
+ * A named band carries its wavenumber and its assignment on two lines, stacked
+ * away from the baseline — upwards from an absorbance maximum, downwards from a
+ * transmittance minimum — so the room has to be on a different side in each
+ * mode. Twenty percent is what those two lines take on a chart of any usual
+ * height.
+ */
+export const LABEL_HEADROOM = 0.2;
+/**
+ * The window that shows everything currently drawn.
+ *
+ * A spectrum marked `excludeFromDomain` is left out of the extents, because it
+ * is a reference held up for comparison rather than data: letting it move the
+ * axes would throw away the zoom the user set every time they held one up. The
+ * exclusion is dropped when it would leave nothing at all.
+ * @param spectra - Everything the chart holds, drawn or not.
+ * @param mode - Which value axis is being drawn, which decides both the extents
+ * and the side the label room is kept on.
+ * @returns The window, in wavenumbers and in the value axis.
+ */
+export function fullDomain(spectra, mode) {
+    const extent = traceExtent(spectra, mode, false) ?? traceExtent(spectra, mode, true);
+    if (extent === null) {
+        return mode === 'absorbance'
+            ? { x: [400, 4000], y: [0, 1] }
+            : { x: [400, 4000], y: [0, 100] };
+    }
+    const { xMinimum, xMaximum, yMinimum, yMaximum } = extent;
+    const xPadding = (xMaximum - xMinimum) * X_DOMAIN_PADDING;
+    // A spectrum of a single point has no width to take a fraction of.
+    const x = xPadding > 0
+        ? [xMinimum - xPadding, xMaximum + xPadding]
+        : [xMinimum - 1, xMaximum + 1];
+    const ySpan = yMaximum - yMinimum;
+    const yPadding = ySpan > 0 ? ySpan * Y_DOMAIN_PADDING : 1;
+    const headroom = ySpan > 0 ? ySpan * LABEL_HEADROOM : 1;
+    const down = bandsPointDown(mode);
+    const y = [
+        yMinimum - (down ? headroom : yPadding),
+        yMaximum + (down ? yPadding : headroom),
+    ];
+    return { x, y };
+}
+/**
+ * What a fitted window was fitted *to*, as one string two renders can compare.
+ *
+ * The chart puts its window back to `fullDomain` when it is handed different
+ * data, and must not when the same data is merely redrawn — so something has to
+ * tell the two apart.
+ *
+ * **The mode is part of it**, and that is the one place this differs from a mass
+ * spectrum's fit key. Switching from transmittance to absorbance does not nudge
+ * the extents, it replaces the value axis outright — a window of 25 to 100
+ * percent means nothing at all in absorbance — so it has to refit, where a
+ * change of colour or of name must not.
+ * @param spectra - Everything the chart holds, drawn or not.
+ * @param mode - Which value axis is being drawn.
+ * @returns A string equal to itself exactly when a fit would be made to the
+ * same thing.
+ */
+export function fittedTo(spectra, mode) {
+    let key = mode;
+    for (const spectrum of spectra) {
+        if (spectrum.excludeFromDomain || !spectrum.visible)
+            continue;
+        key += ` ${spectrum.id}`;
+    }
+    return key;
+}
+/**
+ * The extremes over every trace that is currently drawn.
+ * @param spectra - Everything the chart holds.
+ * @param mode - Which value axis is being drawn.
+ * @param includeExcluded - Whether to count the spectra kept out of the domain.
+ * @returns The extremes, or `null` when nothing is drawn.
+ */
+function traceExtent(spectra, mode, includeExcluded) {
+    let extent = null;
+    for (const spectrum of spectra) {
+        if (!spectrum.visible)
+            continue;
+        if (!includeExcluded && spectrum.excludeFromDomain)
+            continue;
+        const { x, y } = traceOf(spectrum, mode);
+        if (x.length === 0 || y.length === 0)
+            continue;
+        // The wavenumber ends are read off the first and last sample rather than
+        // searched for: the array is ascending by construction, so a scan would walk
+        // every point of the spectrum to learn what index zero already says.
+        const first = x[0];
+        const last = x.at(-1);
+        const lowest = xMinValue(y);
+        const highest = xMaxValue(y);
+        extent =
+            extent === null
+                ? {
+                    xMinimum: first,
+                    xMaximum: last,
+                    yMinimum: lowest,
+                    yMaximum: highest,
+                }
+                : {
+                    xMinimum: Math.min(extent.xMinimum, first),
+                    xMaximum: Math.max(extent.xMaximum, last),
+                    yMinimum: Math.min(extent.yMinimum, lowest),
+                    yMaximum: Math.max(extent.yMaximum, highest),
+                };
+    }
+    return extent;
+}
+//# sourceMappingURL=irDomain.js.map

package/lib/ir/core/irDomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irDomain.js","sourceRoot":"","sources":["../../../src/ir/core/irDomain.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC,kFAAkF;AAClF,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACxB,OAA8B,EAC9B,IAAY;IAEZ,MAAM,MAAM,GACV,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,KAAK,YAAY;YAC1B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;YAC/B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IACtC,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC1D,MAAM,QAAQ,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,gBAAgB,CAAC;IAC1D,mEAAmE;IACnE,MAAM,CAAC,GACL,QAAQ,GAAG,CAAC;QACV,CAAC,CAAC,CAAC,QAAQ,GAAG,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAC5C,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;IAEnC,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,CAAC,GAAqB;QAC1B,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACvC,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;KACxC,CAAC;IACF,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,QAAQ,CAAC,OAA8B,EAAE,IAAY;IACnE,IAAI,GAAG,GAAG,IAAI,CAAC;IACf,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;QAC/B,IAAI,QAAQ,CAAC,iBAAiB,IAAI,CAAC,QAAQ,CAAC,OAAO;YAAE,SAAS;QAC9D,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAcD;;;;;;GAMG;AACH,SAAS,WAAW,CAClB,OAA8B,EAC9B,IAAY,EACZ,eAAwB;IAExB,IAAI,MAAM,GAAuB,IAAI,CAAC;IACtC,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,OAAO;YAAE,SAAS;QAChC,IAAI,CAAC,eAAe,IAAI,QAAQ,CAAC,iBAAiB;YAAE,SAAS;QAC7D,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAC/C,yEAAyE;QACzE,6EAA6E;QAC7E,qEAAqE;QACrE,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAW,CAAC;QAC7B,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAW,CAAC;QAChC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM;YACJ,MAAM,KAAK,IAAI;gBACb,CAAC,CAAC;oBACE,QAAQ,EAAE,KAAK;oBACf,QAAQ,EAAE,IAAI;oBACd,QAAQ,EAAE,MAAM;oBAChB,QAAQ,EAAE,OAAO;iBAClB;gBACH,CAAC,CAAC;oBACE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC;oBAC1C,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC;oBACzC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;oBAC3C,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;iBAC7C,CAAC;IACV,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/ir/core/irEditorApi.d.ts

@@ -0,0 +1,42 @@
+/**
+ * The handle a host drives the viewer through.
+ *
+ * A handle rather than props, for the reason NMRium uses one: "frame this band"
+ * and "take these spectra" are *gestures*, and a gesture expressed as a prop has
+ * to change to be obeyed — so asking for the same window twice does nothing the
+ * second time, and a host ends up inventing a nonce to make it work.
+ */
+import type { IrDomain, IrSpectrum } from './irSpectrum.ts';
+/** How much room to leave either side of a band a host asks to be framed. */
+export interface ZoomToBandOptions {
+    /**
+     * How wide the window is, in cm⁻¹.
+     * @default 200
+     */
+    width?: number;
+}
+/** What a host can ask of the viewer. */
+export interface IrEditorHandle {
+    /** The spectra that are open, in the order they were loaded. */
+    getSpectra: () => IrSpectrum[];
+    /** Draw these instead of what is open, and refit to them. */
+    setSpectra: (spectra: IrSpectrum[]) => void;
+    /** Draw these as well as what is open. */
+    addSpectra: (spectra: IrSpectrum[]) => void;
+    /** Close every spectrum. */
+    clear: () => void;
+    /** Show this window. */
+    setDomain: (domain: IrDomain) => void;
+    /** Show what fits. */
+    resetDomain: () => void;
+    /**
+     * Frame a wavenumber, keeping the value axis as it is.
+     *
+     * The commonest thing a host wants: a band named in a table beside the viewer
+     * is clicked, and the chart should go there.
+     */
+    zoomToWavenumber: (wavenumber: number, options?: ZoomToBandOptions) => void;
+    /** Point the panels at one spectrum, or at none. */
+    selectSpectrum: (id: string | null) => void;
+}
+//# sourceMappingURL=irEditorApi.d.ts.map

package/lib/ir/core/irEditorApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irEditorApi.d.ts","sourceRoot":"","sources":["../../../src/ir/core/irEditorApi.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE5D,6EAA6E;AAC7E,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC7B,gEAAgE;IAChE,UAAU,EAAE,MAAM,UAAU,EAAE,CAAC;IAC/B,6DAA6D;IAC7D,UAAU,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IAC5C,0CAA0C;IAC1C,UAAU,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IAC5C,4BAA4B;IAC5B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,wBAAwB;IACxB,SAAS,EAAE,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC;IACtC,sBAAsB;IACtB,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC5E,oDAAoD;IACpD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;CAC7C"}

package/lib/ir/core/irEditorApi.js

@@ -0,0 +1,10 @@
+/**
+ * The handle a host drives the viewer through.
+ *
+ * A handle rather than props, for the reason NMRium uses one: "frame this band"
+ * and "take these spectra" are *gestures*, and a gesture expressed as a prop has
+ * to change to be obeyed — so asking for the same window twice does nothing the
+ * second time, and a host ends up inventing a nonce to make it work.
+ */
+export {};
+//# sourceMappingURL=irEditorApi.js.map

package/lib/ir/core/irEditorApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irEditorApi.js","sourceRoot":"","sources":["../../../src/ir/core/irEditorApi.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}