Skip to content

Known issues to confirm

This page lists behaviours found while documenting SIV 0.19.0 that look like defects, or where earlier documentation (the in-app help dialogs that this guide replaces, the design notes, the example README) said something the code does not do. Each item is a hypothesis from reading the code: confirm it with the linked test case, then either open an issue or, if the behaviour is intended, move it into the reference pages and retire it here.

Source references are to files under src/lib/ in the repository at 0.19.0 unless shown otherwise.

Status Meaning
Suspected Found by reading the code; not yet reproduced.
Confirmed Reproduced; an issue is linked.
Intended Confirmed as the desired behaviour; documented in the reference, retired.
Doc drift The code is fine; an older document said otherwise. Fixed by this guide.

Viewing

ID Status Test case Observed / suspected behaviour Previously claimed Source Suggested expected behaviour
KI-01 Suspected VIEW-094, VIEW-074, REG-081 OpenSeadragon's built-in keyboard navigation is never disabled. With the canvas focused: r/R rotate 90°, f flips, 0 goes home, w a s d and arrows pan, j/k change pages. So r/f collide with the rectangle/freeform shortcuts, d both pans and deletes, ← / → both pan and step slices, +/- may zoom twice. Shortcuts listed as SIV-only. implementations/osd/openseadragon-viewer-options.ts (keyboardNavEnabled defaults to true in OSD 6) Disable OSD keyboard navigation; SIV's shortcut handler is the only one.
KI-02 Suspected VIEW-089 Heatmap/Contour: each wheel event is a full 1.3× zoom step about the view centre (not the pointer), possibly with a high-definition re-fetch per event; trackpads zoom very fast. Scroll to zoom. visualizer/viewer-shortcuts.ts:133-142; visualizer.component.ts:978 Zoom proportional to the wheel delta, about the pointer, with the re-fetch debounced.
KI-03 Suspected VIEW-053 Test-mode "Image (napari · WebGPU)" is missing from rendererOwnsWheel, so SIV's 1.3×-per-event wheel overrides napari's own wheel zoom. — contracts/plot-type.ts:325-327 napari Image owns the wheel like the other napari types.
KI-04 Suspected VIEW-192 On napari 3D views, Orbital rotation and Turntable rotation both map to rotate and behave the same. Two distinct camera modes. implementations/napari-js/napari-axes-gizmo.ts:56-58 Distinct behaviours, or a single "Rotate" button on napari views.
KI-05 Suspected VIEW-152 Download and Export composite from napari views always save napari-js.png, not the image's name. "Download the current image as a PNG." implementations/napari-js/napari-visualizer.service.ts:810-817 <stem>.png / <stem>_composite.png like the other backends.
KI-06 Suspected VIEW-080, VIEW-081 Fit to view leaves the armed tool armed on the Image view (OpenSeadragon emits no autoscale event) but disarms it on Plotly and napari views. — visualizer.component.ts:785-788; openseadragon-visualizer.service.ts getAutoscaleEvent The same behaviour on every backend.
KI-07 Suspected VIEW-176 Plotly's "Z-plane:" slider numbers slices from 1 while the toolbar's Slice slider numbers them from 0. — implementations/plotly/plotly-layouts.ts:25-40, 66-72 One numbering everywhere.
KI-08 Suspected VIEW-024 The floating toolbar's position is not clamped to the window; it can be dragged off-screen. — visualizer/floating-drag.directive.ts Keep at least the drag handle inside the window.
KI-09 Suspected VIEW-134 Hiding the only "Intensity" channel of a grayscale image blanks it, with no warning. — channel-histogram/channel-histogram.component.html Prevent hiding the last visible channel, or show a hint.
KI-10 Suspected VIEW-177 The Heatmap single-image Slice tooltip says "(← / → keys)", but window-level arrow keys step slices only in the Image view or the slice editor; elsewhere only while the slider has focus. ← / → step slices. visualizer.component.ts:977; toolbar/stack-controls/stack-controls.component.html Arrow keys step slices wherever a Slice slider is shown, or the tooltip says when they work.
KI-11 Doc drift VIEW-195 Code comments say the Res default is ½; the constant is ¼ (NAPARI_DEFAULT_DECIMATE = 4). ½ toolbar/toolbar.component.ts:123; visualizer.component.ts:394; contracts/plot-type.ts:336-345 Fix the comments (¼ is documented in this guide).
KI-12 Suspected VIEW-197 napari Isosurface: the band sets contrastLimits = [lo, hi] with isoThreshold = 0.5, which may draw a single surface at the band midpoint rather than a band; the band is not re-applied after a re-plot (for example a Res change), so the slider and the view can disagree. "Surfaces are drawn for voxels whose intensity falls in the selected band." implementations/napari-js/napari-volume-scene.ts:398-410 The rendered surface matches the band at all times.
KI-13 Doc drift VIEW-133 There is no "reverse" colormap control; only Invert. The store keeps an unused reverseScale. "a reverse toggle and a colormap dropdown" channel-histogram/channel-histogram.component.html:186-211; store/visualizer-store.service.ts Documented as Invert only; remove reverseScale or expose it.
KI-14 Doc drift VIEW-080 Fit to view only fits the view; it does not itself reset stack mode to single-image mode (a host may do so on Plotly autoscale). "In stack mode it also resets to single-image mode." visualizer.component.ts:1169-1171; plotly.service.ts:694-700 Documented as fit only.
KI-15 Doc drift VIEW-075 Zoom out does not stop at the original image size; OpenSeadragon allows down to about 1% (minZoomImageRatio 0.01) and Plotly is unclamped. "stopping at the original image dimensions" implementations/osd/openseadragon-viewer-options.ts Decide: clamp at fit, or document (done here).
KI-42 Suspected VIEW-011 Error toast title is misspelled "An error occured". — visualizer.component.ts:864-879; implementations/plotly/plotly-zoom-controller.ts:122-133, 260-271 "An error occurred".
KI-43 Suspected VIEW-119 Channel colours change only when a picker slider or number field is released, not while dragging. — hex-color-picker/*; channel-histogram.component.html:61 Confirm intended (performance) or apply live.
KI-47 Confirmed VIEW-240, VIEW-242 Intensity lines added while zoomed in are not visible at that zoom level; you have to zoom out, place the lines, then zoom back in. Reported while capturing the guide's screenshots (the profile tool is still a prototype). Lines can be added and edited at any zoom. visualizer/ intensity-profile overlay Lines are placed and drawn in image coordinates at any zoom level.

Regions

ID Status Test case Observed / suspected behaviour Previously claimed Source Suggested expected behaviour
KI-16 Suspected REG-115 Context-menu vertex tools and Bézier conversions are offered only for the OpenSeadragon Image view, not for the napari Image view (whose toolbar does offer the vertex tools). Available "in the Image view". visualizer/visualizer-context-menu.ts:74, 101, 168 Menu and toolbar agree on every Image backend.
KI-17 Suspected REG-027, REG-042 On the Image view, brush size and vertex-eraser radius are applied in the viewport readback's (device) pixels, so they behave like screen pixels and cover more of the image when zoomed out. "Brush diameter in image pixels." / "Eraser radius in image pixels." implementations/osd/osd-pixel-readback.ts:37-66; toolbar/brush/brush-tool.service.ts:179; toolbar/vertex-eraser/vertex-eraser-tool.service.ts:34-70 Sizes in image pixels as labelled, or relabel as screen pixels.
KI-18 Suspected REG-025 No Esc handler cancels an unfinished polygon. — implementations/osd/osd-region-overlay.ts Esc cancels the polygon in progress.
KI-19 Suspected REG-102 Right-clicking a region does not select it; the region actions apply to the current selection. "Right-click a region — or the current multi-selection — to open … Selected region(s)" visualizer.component.ts:991-995 Right-clicking an unselected region selects it first (common convention).
KI-20 Suspected REG-131 Holes (donuts) may be drawn filled (exterior only) in Plotly views. Donuts supported. toolbar/brush/brush-tool.service.ts:45 (comment) Holes are drawn as holes in every view.
KI-36 Doc drift REG-100 There is no "Selected region(s)" header in the context menu; the region actions are simply at the top. "the Selected region(s) group" visualizer/visualizer-context-menu.ts:65-182 Documented without a header.

Region Editor, classes, import and export

ID Status Test case Observed / suspected behaviour Previously claimed Source Suggested expected behaviour
KI-21 Suspected RED-076 The active class is stored only in the editor and never passed to the drawing tools: new rectangle, freeform, wand and brush regions always get "Region". "Set “X” active — new regions use it"; "Click a class to make it active (new regions inherit it)" region-editor/region-editor.component.ts:139, 1153; toolbar/wand/wand-tool.service.ts:171-178; toolbar/brush/brush-tool.service.ts:226-237; implementations/osd/osd-region-overlay.ts:831 New regions take the active class.
KI-22 Suspected RED-087 With the Region Editor open, every unknown region label is added to the class list (and persisted) regardless of the Auto-add checkbox, so labels like sam, cell, Cell appear. Auto-add "adds unmatched classes found on load" only when ticked. region-editor/region-editor.component.ts:1032-1048 (syncClassesFromRegions) Unknown labels are added only when Auto-add is on.
KI-23 Suspected RED-089, RED-091 In Manage annotation classes, Reset and Import apply and save immediately, without Apply, and cannot be discarded by closing the dialog. Edits apply on Apply; closing discards. region-editor/manage-classes-dialog/* Reset and Import fill the draft; Apply commits.
KI-24 Suspected RED-044 x512 rounds rectangle sides to the nearest multiple of 512, so a side under 256 px becomes 0. "round all rectangle widths/heights to the nearest multiple of 512" region-editor/region-editor.component.ts:967-979 Round to at least 512 (never 0).
KI-25 Suspected RED-031 The Class column header shows a sort icon but is not sortable. — region-editor/region-table/region-table.component.html Sortable, or no icon.
KI-26 Suspected RED-164 Save mask uses only the editor's regions for the current slice: no region-source features, no other slices; open polylines may be filled as polygons. "Download mask of the regions" region-editor/mask-export.service.ts; mask-raster.ts:86-139 Document the scope, and skip (or stroke) polylines.
KI-27 Suspected RED-160 The binary mask writes 255 for region pixels, while the option reads "Binary (regions 1, background 0)". regions 1 region-editor/mask-raster.ts:86-139 Match the label (1) or relabel (255).
KI-28 Suspected RED-139 The Import regions file picker does not accept .zip, though zips are supported through the folder and server routes. Zip import supported (CHANGELOG 0.12). region-editor/region-editor.component.html (accept list) Add .zip to the accept list.
KI-29 Suspected RED-129 GeoJSON Point, MultiLineString and GeometryCollection features are not handled; a Point will most likely throw instead of being skipped with a message. — models/region-geojson.ts:32-236 Skip unsupported geometries and report how many were skipped.
KI-30 Intended? RED-123 A feature without classification is imported with the class "Cell". — models/region-geojson.ts Confirm "Cell" (QuPath convention) vs "Region".
KI-31 Doc drift RED-121 Importing a single GeoJSON replaces the image's regions (and drops any region source); it does not append. Not stated. region-editor/region-editor.component.ts:1422-1446 Documented; consider a confirm when regions exist.

Segmentation

ID Status Test case Observed / suspected behaviour Previously claimed Source Suggested expected behaviour
KI-32 Suspected SEG-041, SEG-084 SAM ("sam") and Cellpose ("cell") regions probably show their class's preset or fallback colour, because the store recolours labelled regions that are not colour-overridden. "generated regions inherit the color of the rectangle they came from" store/region-store.service.ts:434, 1546-1551; store/class-color.util.ts:103-118 Decide: rectangle colour (mark as overridden) or class colour (update the guide).
KI-33 Suspected SEG-047 On the Image view, SAM, Cellpose and the wand read the displayed pixels: only the on-screen part of a rectangle is segmented, display colours (contrast, LUT) affect the result, and panning or zooming forces a re-encode. Segments the object inside the rectangle. toolbar/segmentation/canvas-tool.ts:30-37 Document (done here), or read the source pixels at a fixed resolution.
KI-34 Suspected SEG-002 The SAM point-prompt tooltip and status say "click a fiber", a leftover from the muscle-fibre use case. — toolbar/segmentation-tools/segmentation-tools.component.html; toolbar/segmentation/sam-point-tool.service.ts "click an object".
KI-35 Doc drift SEG-020 The model list has four models; the old help listed three (no patho-sam ViT-B (int8)). Three models. toolbar/segmentation/sam-model-registry.ts:24-73 Documented here.

Spatial omics

ID Status Test case Observed / suspected behaviour Previously claimed Source Suggested expected behaviour
KI-37 Suspected SPA-042 The categorical legend in <spatial-key> (rows titled "Select {label}") is never rendered, because the key is shown only for gene or measurement colouring; the Groups list is the legend. "a legend" spatial-controls/spatial-key/spatial-key.component.html:10-23 Remove the dead template, or document.
KI-38 Suspected SPA-076 In 3D, the Show label is rendered even when its only control ("One section at a time") is hidden (unsectioned data, or observations hidden). "Show" toggles volume, cloud and density volumes. spatial-controls/spatial-observations-panel/spatial-observations-panel.component.html:263-290 Hide the label when it has no controls.
KI-39 Doc drift SPA-042 The example tile-server README still says categorical columns stop at about 96 values and that subclass (338) is not served; the limit no longer exists. "Categoricals stop at ~96 values" examples/tile-server/README.md:296-305 Update the README.
KI-40 Doc drift SPA-140 The gene-heatmap All genes view is not served by the example tile server, so it cannot be tested on the live demo. — examples/tile-server/server.mjs (no route) Test in JIT; optionally add a demo route.
KI-44 Doc drift SPA-022 Older docs describe a column dropdown, a gene search and a legend, a 3D "Show" group toggling volume/cloud/density, and an "Annotations" switch on by default. The panel now has Colour by (Group / Gene / Measurement / Single colour), separate Volume and Observations switches, and a Regions section off by default. As described. docs/guides/spatial-omics.md; examples/browser-image/README.md Update the developer guides to match (this guide is current).
KI-48 Confirmed SPA-098, SPA-099 Spatial omics 3D: unselected observations are muted by darkening, not by transparency, so in a dense cloud they still hide the selected cells behind them. Reported while capturing spatial-3d-overview. The selection stands out; the rest is muted. spatial/spatial-encoding.ts (muted alpha); spatial/spatial-selection.ts Unselected observations are drawn far more transparent in 3D (or not depth-written), so the selection shows through them.
KI-49 Confirmed SPA-143 Lasso on the Embedding chart (UMAP, PCA, t-SNE): the map does not update with the lassoed observations, and inside the chart the unselected points are not dimmed enough for the lassoed cluster to stand out. The redraw that fades the rest makes Plotly report an empty selection, which cleared the lasso's selection about 50 ms later. Fixed by #93. The map and the embedding read the same selection. spatial-controls/spatial-charts/plotly-chart-host.ts (bindSelection); implementations/plotly/omics-trace-builders.ts (buildEmbeddingTraces) The lasso selects those observations on the map; unselected points in the chart are clearly faded.

Documentation drift elsewhere

ID Status Observed Source Suggested fix
KI-41 Doc drift The old help's shortcut table omitted ← / → slice stepping, d to delete, _ to zoom out and the slice-editor divider arrow keys. old toolbar-help-dialog.component.html Fixed: see Keyboard shortcuts.
KI-45 Doc drift The boolean-ops design note gives a Simplify default of ~2 px (range 0.5–20); the built dialog uses 3 px (range 1–20). docs/design/region-boolean-ops-design.md Update the design note.
KI-46 Doc drift The holes design note lists hole vertex editing and Bézier holes as out of scope; both are supported now. docs/design/region-holes-design.md Update the design note.