@jax-data-science/sci-image-visualizer 0.17.0 → 0.18.0

package/lib/spatial-controls/spatial-observations-panel/spatial-observations-panel.component.d.ts

@@ -8,16 +8,6 @@ import { PanelOption } from '../../spatial/spatial-panel-model';
 import type { GenePickerModel } from '../spatial-gene-picker';
 import type { SpatialLegendEntry } from '../spatial-key/spatial-key.model';
 import * as i0 from "@angular/core";
-/**
- * The Observations section — one marker per observation (cell centroid, Visium spot) — and
- * what else draws them: what colours them (a column or a gene, mutually exclusive, with
- * the {@link SpatialKeyComponent key}), point size and opacity, the gene map, the 3D scene
- * (volume, cloud, sections, density volumes) and the continuous-only knobs.
- *
- * Renders the section and the sections after it as siblings in the dialog body
- * (`display: contents`). Writes only through the port: `setViewState`, and the colour
- * source's own `colorByColumn` / `colorByFeature` / `clearColorBy`.
- */
 export declare class SpatialObservationsPanelComponent implements OnChanges {
     /** The spatial controls this panel reads and writes through; null without a `SPATIAL_DATA_PORT`. */
     controls: ISpatialControls | null;
@@ -43,6 +33,11 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
     open: boolean;
     /** Asks to open or close it; two-way with `open`. */
     readonly openChange: EventEmitter<boolean>;
+    /**
+     * Whether the dataset's cells can be drawn here (a cell segmentation, and in 3D a 3D one): the
+     * observations are shown as Markers or as Cell segmentations.
+     */
+    cellsAvailable: boolean;
     /** A legend row was clicked (see the key). */
     readonly categoryClicked: EventEmitter<number>;
     protected readonly clipOptions: PanelOption<[number, number]>[];
@@ -50,10 +45,10 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
     protected readonly matchOptions: PanelOption<SpatialViewState['observationGenesMatch']>[];
     /** Virtual-scrolled only past this many options (see the cells panel's gene dropdown). */
     protected readonly geneVirtualScrollFrom = 200;
-    /** Colour-by column choices — "None" plus every column the dataset declares. */
-    protected columnOptions: PanelOption<string | null>[];
-    protected selectedColumn: string | null;
-    protected selectedGene: string | null;
+    /** What the observations are shown as, with a cell segmentation. */
+    protected readonly showAsOptions: PanelOption<'markers' | 'cells'>[];
+    /** The choice of Markers or Cell segmentations, kept while the observations are hidden. */
+    private chosenShownAs;
     /**
      * The dataset's imaged section positions, or null when its z is continuous rather than
      * sectioned. Read once per dataset — the scan walks the z of every observation, so it
@@ -61,10 +56,22 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
      */
     protected sections: Float32Array | null;
     ngOnChanges(changes: SimpleChanges): void;
-    /** Column dropdown. Choosing a column supersedes any gene selection. */
-    protected onColumn(name: string | null): void;
-    /** A gene was picked; it supersedes any column selection. */
-    protected onGene(name: string | null): void;
+    /** Whether the cells are drawn (the explicit choice, or automatically for data that has them). */
+    private get cellsOn();
+    /** Whether the observations are shown at all, as markers or as cells. */
+    protected get observationsShown(): boolean;
+    /** What the observations are shown as (the toggle): the cells while they are drawn, else the
+     *  markers, or, hidden, what was last chosen. */
+    protected get shownAs(): 'markers' | 'cells';
+    /** Show or hide the observations, as what they were shown as. */
+    protected onShowObservations(on: boolean): void;
+    protected onShownAs(as: 'markers' | 'cells' | null): void;
+    /**
+     * Draw the observations as the markers, or as the cells: one or the other, never both (the
+     * renderers draw no markers while the cells are drawn). The markers stay switched on under the
+     * cells, so a view without them (spatial 3D of a 2D segmentation) still shows the markers.
+     */
+    private showAs;
     /** Genes picked for the observation filter; none draws every observation. */
     protected onObservationGenes(genes: string[] | null): void;
     protected onObservationGenesMatch(match: SpatialViewState['observationGenesMatch'] | null): void;
@@ -94,8 +101,6 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
     protected resetGeneStyle(gene: string): void;
     /** What the filter hides, in words. */
     protected get geneFilterHint(): string;
-    /** Cell outlines on offer, which changes what the circles mean. */
-    protected get hasCells(): boolean;
     /** True while a selection is active — everything else renders muted. */
     get hasSelection(): boolean;
     /** Whether log/clip apply — they are continuous-only knobs. */
@@ -122,8 +127,6 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
     protected get geneMapVolumeNote(): string;
     /** True while a gene is the colour source — the only thing a gene map can map. */
     protected get canMapGene(): boolean;
-    protected onShowVolume(on: boolean): void;
-    protected onVolumeOpacity(value: number | undefined): void;
     protected onShowPoints(on: boolean): void;
     /** The "one section at a time" switch: null restores the whole stack. */
     protected onOneSection(on: boolean): void;
@@ -145,5 +148,5 @@ export declare class SpatialObservationsPanelComponent implements OnChanges {
     private static readonly DENSITY_MAX_CLUSTERS;
     protected onClip(value: [number, number]): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SpatialObservationsPanelComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialObservationsPanelComponent, "spatial-observations-panel", never, { "controls": { "alias": "controls"; "required": false; }; "dataset": { "alias": "dataset"; "required": false; }; "view": { "alias": "view"; "required": false; }; "genes": { "alias": "genes"; "required": false; }; "legend": { "alias": "legend"; "required": false; }; "colorBarCss": { "alias": "colorBarCss"; "required": false; }; "selection": { "alias": "selection"; "required": false; }; "selectedCategory": { "alias": "selectedCategory"; "required": false; }; "colormapOptions": { "alias": "colormapOptions"; "required": false; }; "is3d": { "alias": "is3d"; "required": false; }; "open": { "alias": "open"; "required": false; }; }, { "openChange": "openChange"; "categoryClicked": "categoryClicked"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialObservationsPanelComponent, "spatial-observations-panel", never, { "controls": { "alias": "controls"; "required": false; }; "dataset": { "alias": "dataset"; "required": false; }; "view": { "alias": "view"; "required": false; }; "genes": { "alias": "genes"; "required": false; }; "legend": { "alias": "legend"; "required": false; }; "colorBarCss": { "alias": "colorBarCss"; "required": false; }; "selection": { "alias": "selection"; "required": false; }; "selectedCategory": { "alias": "selectedCategory"; "required": false; }; "colormapOptions": { "alias": "colormapOptions"; "required": false; }; "is3d": { "alias": "is3d"; "required": false; }; "open": { "alias": "open"; "required": false; }; "cellsAvailable": { "alias": "cellsAvailable"; "required": false; }; }, { "openChange": "openChange"; "categoryClicked": "categoryClicked"; }, never, ["spatial-cells-panel"], true, never>;
 }

package/lib/spatial-controls/spatial-selection-observations/spatial-selection-observations.component.d.ts

@@ -0,0 +1,48 @@
+import { ChangeDetectorRef, NgZone, OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
+import type { ISpatialControls } from '../../contracts/visualizer.contract';
+import type { ObservationsInSelection } from '../../contracts/display-types';
+import * as i0 from "@angular/core";
+/**
+ * "Observations in selection", in the Observations section: the observations of what is selected —
+ * a cell, a cell type picked on the canvas, the selected regions — by the grouping they are coloured
+ * by (else the cell types), with a few measurements' means, or one cell's id, groupings and values.
+ * Every observation in spatial 3D; in 2D those on the plane shown. See
+ * `ISpatialControls.getObservationsInSelection$`.
+ *
+ * Collapsible; followed only while expanded (and while the Observations section, which holds it, is
+ * open).
+ */
+export declare class SpatialSelectionObservationsComponent implements OnChanges, OnDestroy {
+    private readonly zone;
+    private readonly cdr;
+    /** The spatial controls the list is read through; null without a `SPATIAL_DATA_PORT`. */
+    controls: ISpatialControls | null;
+    /** In spatial 3D: the list is of the whole volume. */
+    is3d: boolean;
+    /** Expanded: the list is followed and shown. */
+    protected expanded: boolean;
+    /** The selection's observations (null until the first answer). */
+    protected list: ObservationsInSelection | null;
+    private sub;
+    constructor(zone: NgZone, cdr: ChangeDetectorRef);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    /** Whether there is a list to offer. */
+    protected get available(): boolean;
+    /** The largest group, for the bars. */
+    protected get max(): number;
+    protected toggle(): void;
+    private watch;
+    /** A measurement as shown: a number to 3 significant figures (with its unit), text as it is. */
+    protected format(m: {
+        value: string | number;
+        unit?: string;
+    }): string;
+    /** The groups as tab-separated text (group, observations), for a spreadsheet. */
+    protected copy(): void;
+    protected trackGroup(_i: number, g: {
+        name: string;
+    }): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SpatialSelectionObservationsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialSelectionObservationsComponent, "spatial-selection-observations", never, { "controls": { "alias": "controls"; "required": false; }; "is3d": { "alias": "is3d"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/spatial-controls/spatial-selection-transcripts/spatial-selection-transcripts.component.d.ts

@@ -0,0 +1,43 @@
+import { ChangeDetectorRef, NgZone, OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
+import type { ISpatialControls } from '../../contracts/visualizer.contract';
+import type { TranscriptsInSelection } from '../../contracts/display-types';
+import * as i0 from "@angular/core";
+/**
+ * "Transcripts in selection", in the Transcripts section: the transcripts of what is selected, by
+ * gene, most frequent first — through the volume in spatial 3D (a cell, or a cell type picked on the
+ * canvas), on the plane shown in 2D (the selected cells or regions). See
+ * `ISpatialControls.getTranscriptsInSelection$`.
+ *
+ * Collapsible; counted only while expanded (and while the Transcripts section, which holds it, is
+ * open): the counts read the finest transcript tiles of the selection.
+ */
+export declare class SpatialSelectionTranscriptsComponent implements OnChanges, OnDestroy {
+    private readonly zone;
+    private readonly cdr;
+    /** The spatial controls the list is read through; null without a `SPATIAL_DATA_PORT`. */
+    controls: ISpatialControls | null;
+    /** In spatial 3D: the list is of the whole volume. */
+    is3d: boolean;
+    /** Expanded: the list is counted and shown. */
+    protected expanded: boolean;
+    /** The selection's transcripts by gene (null until the first answer). */
+    protected list: TranscriptsInSelection | null;
+    private sub;
+    constructor(zone: NgZone, cdr: ChangeDetectorRef);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    /** Whether there is a list to offer: the controls count transcripts. */
+    protected get available(): boolean;
+    /** The largest gene count, for the bars. */
+    protected get max(): number;
+    protected toggle(): void;
+    /** Subscribe while expanded, else not (a collapsed list reads nothing). */
+    private watch;
+    /** The list as tab-separated text (gene, count), for a spreadsheet. */
+    protected copy(): void;
+    protected trackGene(_i: number, g: {
+        name: string;
+    }): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SpatialSelectionTranscriptsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialSelectionTranscriptsComponent, "spatial-selection-transcripts", never, { "controls": { "alias": "controls"; "required": false; }; "is3d": { "alias": "is3d"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/spatial-controls/spatial-transcripts-panel/spatial-transcripts-panel.component.d.ts

@@ -29,6 +29,8 @@ export declare class SpatialTranscriptsPanelComponent implements OnChanges {
     controls: ISpatialControls | null;
     /** The dataset on offer, or null. */
     dataset: SpatialDataset | null;
+    /** In spatial 3D (the transcripts in selection are then the whole volume's). */
+    is3d: boolean;
     /** The current spatial view state: what is drawn, and how. */
     view: SpatialViewState;
     /** The gene list the transcript genes are picked from, shared with the other gene dropdowns. */
@@ -150,5 +152,5 @@ export declare class SpatialTranscriptsPanelComponent implements OnChanges {
     /** '⋮' menu. */
     private buildGeneMenu;
     static ɵfac: i0.ɵɵFactoryDeclaration<SpatialTranscriptsPanelComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialTranscriptsPanelComponent, "spatial-transcripts-panel", never, { "controls": { "alias": "controls"; "required": false; }; "dataset": { "alias": "dataset"; "required": false; }; "view": { "alias": "view"; "required": false; }; "genes": { "alias": "genes"; "required": false; }; "estimate": { "alias": "estimate"; "required": false; }; "densityStats": { "alias": "densityStats"; "required": false; }; "geneCounts": { "alias": "geneCounts"; "required": false; }; "colormapOptions": { "alias": "colormapOptions"; "required": false; }; "open": { "alias": "open"; "required": false; }; }, { "openChange": "openChange"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpatialTranscriptsPanelComponent, "spatial-transcripts-panel", never, { "controls": { "alias": "controls"; "required": false; }; "dataset": { "alias": "dataset"; "required": false; }; "is3d": { "alias": "is3d"; "required": false; }; "view": { "alias": "view"; "required": false; }; "genes": { "alias": "genes"; "required": false; }; "estimate": { "alias": "estimate"; "required": false; }; "densityStats": { "alias": "densityStats"; "required": false; }; "geneCounts": { "alias": "geneCounts"; "required": false; }; "colormapOptions": { "alias": "colormapOptions"; "required": false; }; "open": { "alias": "open"; "required": false; }; }, { "openChange": "openChange"; }, never, never, true, never>;
 }

package/lib/store/region-source-scope.d.ts

@@ -51,6 +51,10 @@ export declare class RegionSourceScope {
     slicesWithSource(image: string | undefined): number[];
     /** Whether `image` has one source over all its slices. */
     hasPlanesSource(image: string | undefined): boolean;
+    /** The opener of `image`'s source over all its slices (as attached), or null without one. */
+    planesOpener(image: string | undefined): RegionSourceOpener | null;
+    /** Whether `image` has any source: one over all its slices, or one of a slice's own. */
+    hasAny(image: string | undefined): boolean;
     /**
      * The source behind `slice` of `image`, opening it if needed. Resolves null when there is
      * none, and rejects when it cannot be opened.

package/lib/store/region-store.service.d.ts

@@ -92,6 +92,8 @@ export declare class RegionStore implements IRegionStore, IRegionEditApi, IRegio
      */
     private readonly sources;
     private readonly sourceView$;
+    /** Whether the overlays draw the source (see setRegionSourceDrawn). */
+    private readonly sourceDrawn$;
     /** The region look the user chose (overrides the source's hint), field by field. */
     private userStyle;
     /** The current source's style hint. */
@@ -355,10 +357,29 @@ export declare class RegionStore implements IRegionStore, IRegionEditApi, IRegio
     dropSliceRegionSource(): Promise<void>;
     /** Whether the slice shown has a region source. */
     hasRegionSource(): boolean;
+    /** Whether the current image has any region source, over all its slices or a slice's own. */
+    hasAnyRegionSource(): boolean;
+    /**
+     * The opener of the current image's source over all its slices, as attached (see
+     * {@link attachRegionSource}), or null without one: tells whose source it still is.
+     */
+    getPlanesSourceOpener(): RegionSourceOpener | null;
     /** The slice's region source as a source layer draws it; null without one (or until it opens). */
     getRegionSourceView(): RegionSourceView | null;
     /** {@link getRegionSourceView} and every change of it (slice, taken ids, class colours). */
     getRegionSourceView$(): Observable<RegionSourceView | null>;
+    /**
+     * The source view the overlays draw: {@link getRegionSourceView$}, or null while the source is
+     * drawn by another layer instead (see {@link setRegionSourceDrawn}). The Region Editor's list
+     * and the source's other uses keep reading the source itself.
+     */
+    getDrawnRegionSourceView$(): Observable<RegionSourceView | null>;
+    /**
+     * Whether the overlays draw the region source (default), or leave it to another layer that draws
+     * the same outlines (the 2D spatial view's cells, from a 3D segmentation's region set), so they
+     * are not drawn twice. Only the drawing: the source stays attached, listed and editable.
+     */
+    setRegionSourceDrawn(drawn: boolean): void;
     /**
      * Take source features into the working set for editing: their exact geometry becomes
      * ordinary regions (minted, coloured and slice-tagged as any region entering the store) and

package/lib/toolbar/toolbar.component.d.ts

@@ -41,6 +41,11 @@ export declare class ToolbarComponent {
     isoRange: number[];
     /** The last slice index of a stack. */
     maxIndex: number;
+    /**
+     * The image is one plane, but a spatial dataset's region set slices it into planes: the live
+     * views offer the slider over them ({@link maxIndex} is the last plane), as over a stack.
+     */
+    planeSlices: boolean;
     /** The current slice (0-based). */
     zIndex: number;
     /** True for any 2D (non Surface-3D) plot type. */
@@ -231,5 +236,5 @@ export declare class ToolbarComponent {
     protected get isIntensityCapable(): boolean;
     protected showHelp(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ToolbarComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ToolbarComponent, "plotting-toolbar", never, { "imageInfo": { "alias": "imageInfo"; "required": false; }; "hasSpatialDataset": { "alias": "hasSpatialDataset"; "required": false; }; "plotTypeOptions": { "alias": "plotTypeOptions"; "required": false; }; "selectedPlotType": { "alias": "selectedPlotType"; "required": false; }; "basePlotType": { "alias": "basePlotType"; "required": false; }; "isoRange": { "alias": "isoRange"; "required": false; }; "maxIndex": { "alias": "maxIndex"; "required": false; }; "zIndex": { "alias": "zIndex"; "required": false; }; "isHeatmap": { "alias": "isHeatmap"; "required": false; }; "is3dRegions": { "alias": "is3dRegions"; "required": false; }; "isVolumeView": { "alias": "isVolumeView"; "required": false; }; "sliceEditor": { "alias": "sliceEditor"; "required": false; }; "activeDragMode": { "alias": "activeDragMode"; "required": false; }; "activeSurface3dMode": { "alias": "activeSurface3dMode"; "required": false; }; "axesVisible": { "alias": "axesVisible"; "required": false; }; "wireframeActive": { "alias": "wireframeActive"; "required": false; }; "resolutionScale": { "alias": "resolutionScale"; "required": false; }; "wandSensitivity": { "alias": "wandSensitivity"; "required": false; }; "brushSize": { "alias": "brushSize"; "required": false; }; "vertexEraserRadius": { "alias": "vertexEraserRadius"; "required": false; }; "canUndo": { "alias": "canUndo"; "required": false; }; "canRedo": { "alias": "canRedo"; "required": false; }; "stackOptions": { "alias": "stackOptions"; "required": false; }; "tools": { "alias": "tools"; "required": false; }; "imageSmoothingEnabled": { "alias": "imageSmoothingEnabled"; "required": false; }; "samModels": { "alias": "samModels"; "required": false; }; "samModelId": { "alias": "samModelId"; "required": false; }; "contributedTools": { "alias": "contributedTools"; "required": false; }; "dialogTools": { "alias": "dialogTools"; "required": false; }; "openDialogToolId": { "alias": "openDialogToolId"; "required": false; }; "toolModelIds": { "alias": "toolModelIds"; "required": false; }; }, { "selectPlotType": "selectPlotType"; "addProfileLine": "addProfileLine"; "toggleImageSmoothing": "toggleImageSmoothing"; "isoRangeChange": "isoRangeChange"; "openChannelHistogram": "openChannelHistogram"; "openSpatialControls": "openSpatialControls"; "openRegionEditor": "openRegionEditor"; "toggleSliceEditor": "toggleSliceEditor"; "selectStackOption": "selectStackOption"; "zScrub": "zScrub"; "zSlide": "zSlide"; "zIndexInput": "zIndexInput"; "reloadAndPlot": "reloadAndPlot"; "downloadImage": "downloadImage"; "autoscaleImage": "autoscaleImage"; "toggleDragMode": "toggleDragMode"; "zoomIn": "zoomIn"; "zoomOut": "zoomOut"; "toggleSurface3dMode": "toggleSurface3dMode"; "resetSurfaceCamera": "resetSurfaceCamera"; "toggleAxes": "toggleAxes"; "toggleWireframe": "toggleWireframe"; "selectResolution": "selectResolution"; "deleteRegion": "deleteRegion"; "undoRegion": "undoRegion"; "redoRegion": "redoRegion"; "segmentRegions": "segmentRegions"; "segmentCellpose": "segmentCellpose"; "runTool": "runTool"; "toggleDialogTool": "toggleDialogTool"; "toolModelChange": "toolModelChange"; "openToolParams": "openToolParams"; "samModelChange": "samModelChange"; "wandSensitivityChange": "wandSensitivityChange"; "brushSizeChange": "brushSizeChange"; "vertexEraserRadiusChange": "vertexEraserRadiusChange"; }, never, ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ToolbarComponent, "plotting-toolbar", never, { "imageInfo": { "alias": "imageInfo"; "required": false; }; "hasSpatialDataset": { "alias": "hasSpatialDataset"; "required": false; }; "plotTypeOptions": { "alias": "plotTypeOptions"; "required": false; }; "selectedPlotType": { "alias": "selectedPlotType"; "required": false; }; "basePlotType": { "alias": "basePlotType"; "required": false; }; "isoRange": { "alias": "isoRange"; "required": false; }; "maxIndex": { "alias": "maxIndex"; "required": false; }; "planeSlices": { "alias": "planeSlices"; "required": false; }; "zIndex": { "alias": "zIndex"; "required": false; }; "isHeatmap": { "alias": "isHeatmap"; "required": false; }; "is3dRegions": { "alias": "is3dRegions"; "required": false; }; "isVolumeView": { "alias": "isVolumeView"; "required": false; }; "sliceEditor": { "alias": "sliceEditor"; "required": false; }; "activeDragMode": { "alias": "activeDragMode"; "required": false; }; "activeSurface3dMode": { "alias": "activeSurface3dMode"; "required": false; }; "axesVisible": { "alias": "axesVisible"; "required": false; }; "wireframeActive": { "alias": "wireframeActive"; "required": false; }; "resolutionScale": { "alias": "resolutionScale"; "required": false; }; "wandSensitivity": { "alias": "wandSensitivity"; "required": false; }; "brushSize": { "alias": "brushSize"; "required": false; }; "vertexEraserRadius": { "alias": "vertexEraserRadius"; "required": false; }; "canUndo": { "alias": "canUndo"; "required": false; }; "canRedo": { "alias": "canRedo"; "required": false; }; "stackOptions": { "alias": "stackOptions"; "required": false; }; "tools": { "alias": "tools"; "required": false; }; "imageSmoothingEnabled": { "alias": "imageSmoothingEnabled"; "required": false; }; "samModels": { "alias": "samModels"; "required": false; }; "samModelId": { "alias": "samModelId"; "required": false; }; "contributedTools": { "alias": "contributedTools"; "required": false; }; "dialogTools": { "alias": "dialogTools"; "required": false; }; "openDialogToolId": { "alias": "openDialogToolId"; "required": false; }; "toolModelIds": { "alias": "toolModelIds"; "required": false; }; }, { "selectPlotType": "selectPlotType"; "addProfileLine": "addProfileLine"; "toggleImageSmoothing": "toggleImageSmoothing"; "isoRangeChange": "isoRangeChange"; "openChannelHistogram": "openChannelHistogram"; "openSpatialControls": "openSpatialControls"; "openRegionEditor": "openRegionEditor"; "toggleSliceEditor": "toggleSliceEditor"; "selectStackOption": "selectStackOption"; "zScrub": "zScrub"; "zSlide": "zSlide"; "zIndexInput": "zIndexInput"; "reloadAndPlot": "reloadAndPlot"; "downloadImage": "downloadImage"; "autoscaleImage": "autoscaleImage"; "toggleDragMode": "toggleDragMode"; "zoomIn": "zoomIn"; "zoomOut": "zoomOut"; "toggleSurface3dMode": "toggleSurface3dMode"; "resetSurfaceCamera": "resetSurfaceCamera"; "toggleAxes": "toggleAxes"; "toggleWireframe": "toggleWireframe"; "selectResolution": "selectResolution"; "deleteRegion": "deleteRegion"; "undoRegion": "undoRegion"; "redoRegion": "redoRegion"; "segmentRegions": "segmentRegions"; "segmentCellpose": "segmentCellpose"; "runTool": "runTool"; "toggleDialogTool": "toggleDialogTool"; "toolModelChange": "toolModelChange"; "openToolParams": "openToolParams"; "samModelChange": "samModelChange"; "wandSensitivityChange": "wandSensitivityChange"; "brushSizeChange": "brushSizeChange"; "vertexEraserRadiusChange": "vertexEraserRadiusChange"; }, never, ["*"], true, never>;
 }

package/lib/visualizer/spatial-region-set.d.ts

@@ -0,0 +1,55 @@
+import { Observable } from 'rxjs';
+import { IImageInfo } from '../contracts/image.contract';
+import { SpatialDataPort } from '../contracts/ports/spatial-data.port';
+import { SpatialDataset } from '../contracts/spatial-dataset.contract';
+import type { RegionSourceOpener } from '../store/region-source-scope';
+/** What {@link SpatialRegionSetLink} attaches a dataset's region set through (the router). */
+export interface DatasetRegionSetTarget {
+    attachDatasetRegionSet?(open: RegionSourceOpener, key: string): Promise<boolean>;
+    releaseDatasetRegionSet?(keep: string | null): void;
+}
+/**
+ * The region set a spatial dataset's boundaries name (a 3D segmentation's cells, see
+ * `SpatialPolygonTilesMeta.sets`): the default set's when it names one, else the first that does.
+ */
+export declare function datasetRegionSet(dataset: SpatialDataset | null | undefined): string | null;
+/**
+ * Whether `info` is the dataset's own image, the one its `imageRef` names. Exactly, when the host
+ * gives the image's id ({@link IImageInfo.imageId}); otherwise by the file name the id ends in (the
+ * host opens the image by that id, a path), which images of other datasets can share: then the link
+ * only takes an image that landed after the dataset was selected (see {@link SpatialRegionSetLink}).
+ * Not the reference volume's stack, which a dataset without an `imageRef` is drawn over: the region
+ * set's coordinates are not its pixels.
+ */
+export declare function isDatasetImage(info: IImageInfo | null | undefined, dataset: SpatialDataset | null | undefined): boolean;
+/**
+ * Attaches a spatial dataset's region set to its image in the region editor, once both are there:
+ * the dataset (the port's) and its image, landed. Each time either changes it asks again; the
+ * target attaches once per image and set.
+ *
+ * An image that landed while another dataset was selected is not taken for this one by its file name,
+ * only by its id ({@link IImageInfo.imageId}): a host selects the dataset and then opens its image,
+ * and until that lands the image on screen is the previous dataset's, though its file name may be the
+ * same (every converted bundle's is `plate.ome.tif`). One that landed with no dataset selected may be.
+ */
+export declare class SpatialRegionSetLink {
+    private readonly port;
+    private readonly target;
+    private dataset;
+    private image;
+    /** The dataset selected when the image landed (its id), or null: none was. */
+    private imageDataset;
+    /** The region set last asked to be attached, until the dataset stops naming it. */
+    private asked;
+    constructor(port: SpatialDataPort | undefined, target: DatasetRegionSetTarget);
+    /** Follow the port's dataset until `until$` emits. */
+    bind(until$: Observable<unknown>): void;
+    /** An image landed (its render settled): the dataset's own, perhaps. */
+    imageLanded(info: IImageInfo): void;
+    /**
+     * Whether the landed image may be the dataset's: by its id when the host gives one, else only when
+     * it landed under this dataset or under none (see the class's note).
+     */
+    private imageOf;
+    private sync;
+}

package/lib/visualizer.component.d.ts

@@ -122,6 +122,11 @@ export declare class VisualizerComponent implements OnInit, OnChanges, AfterView
     private readonly consumedSliceHints;
     protected zIndex: number;
     protected maxIndex: number;
+    /**
+     * Planes of the spatial dataset's region set slicing the image, an image of one plane (see
+     * `IVisualizer.getDatasetPlanes$`): the slider then runs over them. 0 without.
+     */
+    protected datasetPlanes: number;
     contextMenu: ContextMenu;
     protected contextMenuItems: MenuItem[];
     /** The armed tool mode and the toolbar's tool settings. */
@@ -285,6 +290,8 @@ export declare class VisualizerComponent implements OnInit, OnChanges, AfterView
     protected isoRange: number[];
     /** The spatial-omics dataset on offer and the gates it puts on the selector. */
     protected readonly spatial: SpatialDatasetBinder;
+    /** Attaches a spatial dataset's region set (a 3D segmentation's cells) to its image's regions. */
+    private readonly regionSetLink;
     /** Whether a spatial-omics dataset is published on `SPATIAL_DATA_PORT` — gates the
      *  spatial plot types; the toolbar offers the plot modes for an image-less one too. */
     protected get hasSpatialDataset(): boolean;
@@ -298,6 +305,13 @@ export declare class VisualizerComponent implements OnInit, OnChanges, AfterView
     /** Follow the spatial-omics dataset: a dataset appearing, switching or being cleared
      *  re-gates the selector exactly as the image stream and the test-mode toggle do. */
     private watchSpatialDataset;
+    /**
+     * The slider over the dataset's planes, on an image of one plane: its bounds are the planes'
+     * (none left: back to the image's one), the slice kept within them.
+     */
+    private layOutPlanes;
+    /** The last slice index the dataset's planes give an image of one plane (0 without). */
+    private planeMaxIndex;
     /** Recompute the selector's entries for the current image, dataset and test mode
      *  (see {@link computePlotTypeMenu}). */
     private computePlotTypeOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jax-data-science/sci-image-visualizer",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "engines": {
     "node": ">=20.9.0"
   },