@niivue/nv-web-component 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/nvscene-controller.d.ts

@@ -0,0 +1,140 @@
+import { NiiVueOptions, NVImage, default as NiiVue, SLICE_TYPE } from '@niivue/niivue';
+import { LayoutConfig } from './layouts';
+import { ImageFromUrlOptions, NvSceneEventMap, ViewerState } from './types';
+export { SLICE_TYPE };
+export type NiivueCallback = (nv: NiiVue, index: number) => void;
+export interface ViewerSlot {
+    id: string;
+    niivue: NiiVue;
+    canvasElement: HTMLCanvasElement;
+    containerDiv: HTMLDivElement;
+    ready: Promise<void>;
+}
+export interface NvSceneControllerSnapshot {
+    currentLayout: string;
+    viewerCount: number;
+    slots: number;
+    isBroadcasting: boolean;
+    isLoading: boolean;
+    viewerStates: ViewerState[];
+}
+export interface BroadcastOptions {
+    '2d': boolean;
+    '3d': boolean;
+}
+export interface SliceLayoutTile {
+    sliceType: number;
+    position: [number, number, number, number];
+    sliceMM?: number;
+}
+export interface SliceLayoutConfig {
+    label: string;
+    layout: SliceLayoutTile[];
+}
+/**
+ * Default slice layout: Axial as hero (80% height), coronal and sagittal below (20% height each, side by side)
+ */
+export declare const defaultSliceLayout: SliceLayoutTile[];
+/**
+ * Split view: sagittal left, coronal/axial stacked on the right.
+ */
+export declare const splitSliceLayout: SliceLayoutTile[];
+/**
+ * Tri-fan: three equal horizontal panels.
+ */
+export declare const triSliceLayout: SliceLayoutTile[];
+/**
+ * Stacked: three equal vertical stacks.
+ */
+export declare const stackedSliceLayout: SliceLayoutTile[];
+/**
+ * Quad: axial/coronal/sagittal with a render tile.
+ */
+export declare const quadSliceLayout: SliceLayoutTile[];
+/**
+ * Hero render with three small orthogonal slices below.
+ */
+export declare const heroRenderSliceLayout: SliceLayoutTile[];
+export declare const defaultSliceLayouts: Record<string, SliceLayoutConfig>;
+type Listener = () => void;
+export declare const defaultViewerOptions: Partial<NiiVueOptions>;
+/**
+ * An NvSceneController is a declarative representation of what we want to render with Niivue.
+ *
+ * A scene can contain multiple Niivue instances. Each Niivue instance has its own
+ * canvas element for the WebGL2 context. All canvas elements are wrapped in container
+ * divs that are children of the main scene container element.
+ *
+ * Canvas elements are added/removed on-demand based on the scene definition.
+ *
+ * The scene layout controls the position of each canvas via layout functions that
+ * return absolute positioning styles. The scene container is responsive and maintains
+ * the requested layout proportionally.
+ */
+export declare class NvSceneController {
+    containerElement: HTMLElement | null;
+    viewers: ViewerSlot[];
+    currentLayout: string;
+    slots: number;
+    layouts: Record<string, LayoutConfig>;
+    onViewerCreated?: NiivueCallback;
+    private listeners;
+    private snapshotCache;
+    private nextId;
+    private viewersById;
+    private broadcasting;
+    private broadcastOptions;
+    private viewerSliceLayouts;
+    private viewerDefaults;
+    private eventListeners;
+    private loadingCounts;
+    private viewerErrors;
+    constructor(layouts?: Record<string, LayoutConfig>, viewerDefaults?: Partial<NiiVueOptions>);
+    on<E extends keyof NvSceneEventMap>(event: E, cb: NvSceneEventMap[E]): () => void;
+    off<E extends keyof NvSceneEventMap>(event: E, cb: NvSceneEventMap[E]): void;
+    private emit;
+    subscribe: (listener: Listener) => (() => void);
+    getSnapshot: () => NvSceneControllerSnapshot;
+    private notify;
+    setContainerElement(element: HTMLElement | null): void;
+    setLayout(layoutName: string): void;
+    updateLayout(): void;
+    canAddViewer(): boolean;
+    getNiivue(index: number): NiiVue | undefined;
+    getAllNiivue(): NiiVue[];
+    forEachNiivue(callback: NiivueCallback): void;
+    private hasSyncableContent;
+    private safeBroadcastTo;
+    private rewireBroadcasting;
+    setBroadcasting(enabled: boolean, options?: Partial<BroadcastOptions>): void;
+    isBroadcasting(): boolean;
+    setViewerSliceLayout(index: number, layout: SliceLayoutTile[] | null): void;
+    getViewerSliceLayout(index: number): SliceLayoutTile[] | null;
+    private applySliceLayout;
+    getNiivueById(id: string): NiiVue | undefined;
+    getViewerById(id: string): ViewerSlot | undefined;
+    private waitForViewerReady;
+    loadVolume(index: number, opts: ImageFromUrlOptions): Promise<NVImage>;
+    loadVolumes(index: number, opts: ImageFromUrlOptions[]): Promise<NVImage[]>;
+    removeVolume(index: number, url: string): Promise<void>;
+    /**
+     * Look up the Niivue instance and NVImage at the given viewer and volume indices.
+     * Returns undefined if either index is out of bounds.
+     */
+    private findVolume;
+    /** Set the colormap for a volume at the given viewer and volume index. */
+    setColormap(viewerIndex: number, volumeIndex: number, colormap: string): Promise<void>;
+    /** Set the intensity range (calMin / calMax) for a volume at the given viewer and volume index. */
+    setCalMinMax(viewerIndex: number, volumeIndex: number, calMin: number, calMax: number): Promise<void>;
+    /** Set the opacity for a volume at the given viewer and volume index. */
+    setOpacity(viewerIndex: number, volumeIndex: number, opacity: number): Promise<void>;
+    private incrementLoading;
+    private decrementLoading;
+    private addError;
+    private getViewerIndex;
+    addViewer(options?: Partial<NiiVueOptions>): Promise<ViewerSlot>;
+    removeViewer(index: number, shouldNotify?: boolean): void;
+    private disposeViewer;
+    clearViewers(): void;
+    reset(): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import { default as NiiVue, ImageFromUrlOptions, NiiVueOptions, NVImage } from '@niivue/niivue';
+export type { ImageFromUrlOptions, NiiVueOptions, NVImage };
+export interface NvSceneEventMap {
+    viewerCreated: (nv: NiiVue, index: number) => void;
+    viewerRemoved: (index: number) => void;
+    locationChange: (viewerIndex: number, data: unknown) => void;
+    imageLoaded: (viewerIndex: number, volume: NVImage) => void;
+    error: (viewerIndex: number, error: unknown) => void;
+    volumeAdded: (viewerIndex: number, imageOptions: ImageFromUrlOptions, image: NVImage) => void;
+    volumeRemoved: (viewerIndex: number, url: string) => void;
+    colormapChanged: (viewerIndex: number, volumeIndex: number, colormap: string) => void;
+    intensityChanged: (viewerIndex: number, volumeIndex: number, cal_min: number, cal_max: number) => void;
+    opacityChanged: (viewerIndex: number, volumeIndex: number, opacity: number) => void;
+}
+export interface ViewerState {
+    id: string;
+    loading: number;
+    errors: unknown[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@niivue/nv-web-component",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.21",
   "private": false,
   "type": "module",
   "description": "Web component bindings for NiiVue",
@@ -26,10 +26,10 @@
     "test": "bun test"
   },
   "peerDependencies": {
-    "@niivue/niivue": "1.0.0-rc.4"
+    "@niivue/niivue": "1.0.0-rc.23"
   },
   "devDependencies": {
-    "@niivue/niivue": "1.0.0-rc.4",
+    "@niivue/niivue": "1.0.0-rc.23",
     "@types/bun": "^1.3.12",
     "typescript": "^5.9.3",
     "vite": "^8.0.9",