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

package/README.md

@@ -155,7 +155,7 @@ Properties:
 - `volumes: ImageFromUrlOptions[]` - declarative volume list, diffed automatically.
 - `options: Partial<NiiVueOptions>` - NiiVue construction options.
 - `sliceType: number` / `slice-type` attribute - active slice type.
-- `nv: NiiVueGPU | null` - raw NiiVue instance after initialization.
+- `nv: NiiVue | null` - raw NiiVue instance after initialization.
 
 Methods:
 

package/dist/layouts.d.ts

@@ -0,0 +1,20 @@
+export interface CanvasPosition {
+    top: string;
+    left: string;
+    width: string;
+    height: string;
+}
+export type LayoutFunction = (containerElement: HTMLElement, index: number, total: number) => CanvasPosition;
+export interface LayoutConfig {
+    slots: number;
+    label: string;
+    layoutFunction: LayoutFunction;
+}
+export declare const layout1x1: LayoutFunction;
+export declare const layout2x2: LayoutFunction;
+export declare const layout1x2: LayoutFunction;
+export declare const layout2x1: LayoutFunction;
+export declare const layout1x3: LayoutFunction;
+export declare const layout3x1: LayoutFunction;
+export declare const layout3x3: LayoutFunction;
+export declare const defaultLayouts: Record<string, LayoutConfig>;

package/dist/niivue-web-component.d.ts

@@ -0,0 +1,107 @@
+import { NiiVueOptions, NVImage, default as NiiVue, DRAG_MODE, SLICE_TYPE } from '@niivue/niivue';
+import { LitElement, PropertyValues } from 'lit';
+import { defaultLayouts } from './layouts';
+import { defaultSliceLayouts, defaultViewerOptions, NvSceneController, NvSceneControllerSnapshot, SliceLayoutTile } from './nvscene-controller';
+import { ImageFromUrlOptions } from './types';
+export declare const defaultElementName = "niivue-viewer";
+export declare const defaultSceneElementName = "niivue-scene";
+export type NiivueWebComponentOptions = {
+    elementName?: string;
+    sceneElementName?: string;
+};
+type VolumeVisualProps = {
+    colormap?: string;
+    calMin?: number;
+    calMax?: number;
+    opacity?: number;
+};
+export declare const volumeKey: (opts: ImageFromUrlOptions) => string;
+export declare const volumeIdentity: (volume: Pick<NVImage, "url" | "name">) => string;
+export declare const extractVisualProps: (opts: ImageFromUrlOptions) => VolumeVisualProps;
+export declare const volumeVisualUpdates: (next: VolumeVisualProps, prev: VolumeVisualProps) => Partial<VolumeVisualProps>;
+export declare const volumeIndexByKey: (volumes: Pick<NVImage, "url" | "name">[], key: string) => number;
+export declare class NiivueViewerElement extends LitElement {
+    static properties: {
+        volumes: {
+            attribute: boolean;
+        };
+        options: {
+            attribute: boolean;
+        };
+        sliceType: {
+            type: NumberConstructor;
+            attribute: string;
+        };
+    };
+    static styles: import('lit').CSSResult;
+    volumes: ImageFromUrlOptions[];
+    options: Partial<NiiVueOptions>;
+    sliceType: 0;
+    private niivue;
+    private resizeObserver;
+    private loadedVolumes;
+    private attachmentReady;
+    private attachmentGeneration;
+    get nv(): NiiVue | null;
+    render(): import('lit-html').TemplateResult<1>;
+    firstUpdated(): void;
+    updated(changed: PropertyValues<this>): void;
+    disconnectedCallback(): void;
+    private emitError;
+    private ownsAttachment;
+    private getAttachedNiivue;
+    setColormap(volumeIndex: number, colormap: string): Promise<void>;
+    setOpacity(volumeIndex: number, opacity: number): Promise<void>;
+    setCalMinMax(volumeIndex: number, calMin: number, calMax: number): Promise<void>;
+    setColorbarVisible(visible: boolean): void;
+    setCrosshairVisible(visible: boolean): void;
+    setPrimaryDragMode(mode: number): void;
+    setSecondaryDragMode(mode: number): void;
+    private syncVolumes;
+    private reconcileVolumeOrder;
+}
+export declare class NiivueSceneElement extends LitElement {
+    static properties: {
+        layout: {
+            type: StringConstructor;
+        };
+        broadcasting: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
+        snapshot: {
+            attribute: boolean;
+        };
+    };
+    static styles: import('lit').CSSResult;
+    layout: string;
+    broadcasting: boolean;
+    snapshot: NvSceneControllerSnapshot;
+    readonly scene: NvSceneController;
+    private unsubscribe;
+    private resizeObserver;
+    constructor();
+    render(): import('lit-html').TemplateResult<1>;
+    firstUpdated(): void;
+    updated(changed: PropertyValues<this>): void;
+    disconnectedCallback(): void;
+    addViewer(options?: Partial<NiiVueOptions>): Promise<import('./nvscene-controller').ViewerSlot>;
+    removeViewer(index: number): void;
+    canAddViewer(): boolean;
+    setViewerSliceLayout(index: number, layout: SliceLayoutTile[] | null): void;
+    loadVolume(index: number, opts: ImageFromUrlOptions): Promise<NVImage>;
+    loadVolumes(index: number, opts: ImageFromUrlOptions[]): Promise<NVImage[]>;
+    removeVolume(index: number, url: string): Promise<void>;
+    setColormap(viewerIndex: number, volumeIndex: number, colormap: string): Promise<void>;
+    setOpacity(viewerIndex: number, volumeIndex: number, opacity: number): Promise<void>;
+    setCalMinMax(viewerIndex: number, volumeIndex: number, calMin: number, calMax: number): Promise<void>;
+    setColorbarVisible(visible: boolean, viewerIndex?: number): void;
+    setCrosshairVisible(visible: boolean, viewerIndex?: number): void;
+    setPrimaryDragMode(mode: number, viewerIndex?: number): void;
+    setSecondaryDragMode(mode: number, viewerIndex?: number): void;
+    private forEachTargetViewer;
+    private forwardSceneEvents;
+}
+export declare function defineNiivueWebComponents(options?: NiivueWebComponentOptions): void;
+export type { ImageFromUrlOptions, NiiVueOptions, NVImage };
+export { DRAG_MODE, defaultLayouts, defaultSliceLayouts, defaultViewerOptions, NvSceneController, SLICE_TYPE, };