@niivue/niivue 0.44.1 → 0.44.2-dev.2

package/README.md

@@ -46,6 +46,15 @@ The command `npm run demo` will minify the project and locally host all of the [
 - [Neuroinformatics Research and Development Group](http://neuroinformatics.uw.edu/) embeds NiiVue in [tractoscope](https://github.com/nrdg/tractoscope)
 - [nilearn](https://nilearn.github.io/stable/index.html) is extending [ipyniivue](https://github.com/niivue/ipyniivue)
 - [niivue-vscode](https://github.com/niivue/niivue-vscode) is a VSCode extension for displaying images
+- [QuantCo](https://www.quantco.com/) is using NiiVue in medical imaging workflows
+- [FSL Clinical](https://fslclinical.com/) is using NiiVue in brain imaging reports
+- [brain2print](https://brain2print.org/) (from the NiiVue team) uses NiiVue for showing both volume data and converted meshes
+- [ct2print](https://ct2print.org/) (from the NiiVue team) uses NiiVue for showing volume and mesh data
+- [ipyniivue](https://github.com/niivue/ipyniivue) allows NiiVue to be used in Jupyter Notebooks
+- [T2Lesion](https://niivue.github.io/T2lesion/) (from the NiiVue team) uses NiiVue to show input data and segmented lesion masks
+- [NiiVue Desktop](https://github.com/niivue/desktop) (from the NiiVue team) uses NiiVue in a crossplatform Electron app
+- [NiiVue iOS](https://github.com/niivue/ios) (from the NiiVue team) uses NiiVue in a hybrid Swift + webView mobile app
+- [NiiVue Neglect](https://niivue.github.io/niivue-neglect/) uses NiiVue to visualise stroke lesion data in the spatial neglect severity prediction tool
 
 # Funding
 

package/build/index.d.ts

@@ -107,6 +107,18 @@ declare enum LabelLineTerminator {
     CIRCLE = "circle",
     RING = "ring"
 }
+declare enum LabelAnchorPoint {
+    NONE = 0,
+    TOPLEFT = 9,
+    TOPCENTER = 10,
+    TOPRIGHT = 12,
+    MIDDLELEFT = 17,
+    MIDDLECENTER = 18,
+    MIDDLERIGHT = 20,
+    BOTTOMLEFT = 33,
+    BOTTOMCENTER = 34,
+    BOTTOMRIGHT = 36
+}
 /**
  * Class representing label style.
  * @ignore
@@ -140,12 +152,14 @@ declare class NVLabel3D {
     text: string;
     style: NVLabel3DStyle;
     points?: number[] | number[][];
+    anchor: LabelAnchorPoint;
+    onClick?: (label: NVLabel3D) => void;
     /**
      * @param text - The text of the label
      * @param style - The style of the label
      * @param points - An array of points label for label lines
      */
-    constructor(text: string, style: NVLabel3DStyle, points?: number[] | number[][]);
+    constructor(text: string, style: NVLabel3DStyle, points?: number[] | number[][], anchor?: LabelAnchorPoint, onClick?: (label: NVLabel3D) => void);
 }
 
 /**
@@ -619,6 +633,7 @@ type NVConfigOptions = {
     isOrientCube: boolean;
     multiplanarPadPixels: number;
     multiplanarForceRender: boolean;
+    multiplanarEqualSize: boolean;
     multiplanarShowRender: SHOW_RENDER;
     isRadiologicalConvention: boolean;
     meshThicknessOn2D: number | string;
@@ -660,6 +675,7 @@ type NVConfigOptions = {
 };
 declare const DEFAULT_OPTIONS: NVConfigOptions;
 type SceneData = {
+    gamma: number;
     azimuth: number;
     elevation: number;
     crosshairPos: vec3;
@@ -672,6 +688,7 @@ type SceneData = {
     clipVolumeHigh: number[];
 };
 declare const INITIAL_SCENE_DATA: {
+    gamma: number;
     azimuth: number;
     elevation: number;
     crosshairPos: vec3;
@@ -696,6 +713,7 @@ type Scene = {
     pan2Dxyzmm: vec4;
     _elevation?: number;
     _azimuth?: number;
+    gamma?: number;
 };
 type DocumentData = {
     title: string;
@@ -1506,6 +1524,7 @@ declare class NVMeshLoaders {
     static readLayer(name: string, buffer: ArrayBuffer, nvmesh: NVMesh, opacity?: number, colormap?: string, colormapNegative?: string, useNegativeCmap?: boolean, cal_min?: number | null, cal_max?: number | null, outlineBorder?: number): NVMeshLayer | undefined;
     static readSMP(buffer: ArrayBuffer, n_vert: number): Float32Array;
     static readSTC(buffer: ArrayBuffer, n_vert: number): Float32Array;
+    static isCurv(buffer: ArrayBuffer): boolean;
     static readCURV(buffer: ArrayBuffer, n_vert: number): Float32Array;
     static readANNOT(buffer: ArrayBuffer, n_vert: number, isReadColortables?: boolean): ANNOT;
     static readNV(buffer: ArrayBuffer): DefaultMeshType;
@@ -1651,6 +1670,7 @@ type SaveImageOptions = {
  * let niivue = new Niivue({crosshairColor: [0,1,0,0.5], textHeight: 0.5}) // a see-through green crosshair, and larger text labels
  */
 declare class Niivue {
+    loaders: {};
     canvas: HTMLCanvasElement | null;
     _gl: WebGL2RenderingContext | null;
     isBusy: boolean;
@@ -2119,6 +2139,7 @@ declare class Niivue {
      * @param file - File object
      */
     loadFromFile(file: File): Promise<void>;
+    useLoader(loader: unknown, fileExt: string, toExt: string): void;
     dropListener(e: DragEvent): void;
     /**
      * insert a gap between slices of a mutliplanar view.
@@ -2598,6 +2619,7 @@ declare class Niivue {
      * @see {@link https://niivue.github.io/niivue/features/document.3d.html | live demo usage}
      */
     saveDocument(fileName?: string, compress?: boolean): Promise<void>;
+    loadImages(images: Array<ImageFromUrlOptions | LoadFromUrlParams>): Promise<this>;
     /**
      * load an array of volume objects
      * @param volumeList - the array of objects to load. each object must have a resolvable "url" property at a minimum
@@ -2945,6 +2967,7 @@ declare class Niivue {
     effectiveCanvasHeight(): number;
     effectiveCanvasWidth(): number;
     getAllLabels(): NVLabel3D[];
+    getConnectomeLabels(): NVLabel3D[];
     getBulletMarginWidth(): number;
     getLegendPanelWidth(): number;
     getLegendPanelHeight(): number;
@@ -2976,9 +2999,10 @@ declare class Niivue {
     screenFieldOfViewMM(axCorSag?: number, forceSliceMM?: boolean): vec3;
     screenFieldOfViewExtendedVox(axCorSag?: number): MM;
     screenFieldOfViewExtendedMM(axCorSag?: number): MM;
-    drawSliceOrientationText(leftTopWidthHeight: number[], axCorSag: SLICE_TYPE): void;
+    drawSliceOrientationText(leftTopWidthHeight: number[], axCorSag: SLICE_TYPE, padLeftTop?: number[]): void;
     xyMM2xyzMM(axCorSag: SLICE_TYPE, sliceFrac: number): number[];
-    draw2D(leftTopWidthHeight: number[], axCorSag: SLICE_TYPE, customMM?: number): void;
+    draw2DMain(leftTopWidthHeight: number[], axCorSag: SLICE_TYPE, customMM?: number): void;
+    draw2D(leftTopWidthHeight: number[], axCorSag: SLICE_TYPE, customMM?: number, imageWidthHeight?: number[]): void;
     calculateMvpMatrix(_unused: unknown, leftTopWidthHeight: number[], azimuth: number, elevation: number): mat4[];
     calculateModelMatrix(azimuth: number, elevation: number): mat4;
     calculateRayDirection(azimuth: number, elevation: number): vec3;
@@ -2997,12 +3021,13 @@ declare class Niivue {
      * @param style - label style
      * @param point - 3D point on the model
      */
-    addLabel(text: string, style: NVLabel3DStyle, points?: number[] | number[][]): NVLabel3D;
+    addLabel(text: string, style: NVLabel3DStyle, points?: number[] | number[][], anchor?: LabelAnchorPoint, onClick?: (label: NVLabel3D) => void): NVLabel3D;
     calculateScreenPoint(point: [number, number, number], mvpMatrix: mat4, leftTopWidthHeight: number[]): vec4;
     getLabelAtPoint(screenPoint: [number, number]): NVLabel3D | null;
     drawLabelLine(label: NVLabel3D, pos: vec2, mvpMatrix: mat4, leftTopWidthHeight: number[], secondPass?: boolean): void;
-    draw3DLabel(label: NVLabel3D, pos: vec2, mvpMatrix: mat4, leftTopWidthHeight: number[], bulletMargin: number, legendWidth: number, secondPass?: boolean): void;
+    draw3DLabel(label: NVLabel3D, pos: vec2, mvpMatrix?: mat4, leftTopWidthHeight?: number[], bulletMargin?: number, legendWidth?: number, secondPass?: boolean): void;
     draw3DLabels(mvpMatrix: mat4, leftTopWidthHeight: number[], secondPass?: boolean): void;
+    drawAnchoredLabels(): void;
     draw3D(leftTopWidthHeight?: number[], mvpMatrix?: mat4 | null, modelMatrix?: mat4 | null, normalMatrix?: mat4 | null, azimuth?: number | null, elevation?: number): string | undefined;
     drawMesh3D(isDepthTest?: boolean, alpha?: number, m?: mat4, modelMtx?: mat4, normMtx?: mat4): void;
     drawCrosshairs3D(isDepthTest?: boolean, alpha?: number, mvpMtx?: mat4 | null, is2DView?: boolean, isSliceMM?: boolean): void;
@@ -3042,4 +3067,4 @@ declare class Niivue {
     set gl(gl: WebGL2RenderingContext | null);
 }
 
-export { type Connectome, type ConnectomeOptions, DEFAULT_OPTIONS, DRAG_MODE, type DocumentData, type DragReleaseParams, type ExportDocumentData, INITIAL_SCENE_DATA, LabelLineTerminator, LabelTextAlignment, type LegacyConnectome, type LegacyNodes, MULTIPLANAR_TYPE, type NVConfigOptions, type NVConnectomeEdge, type NVConnectomeNode, NVController, NVDocument, NVImage, NVImageFromUrlOptions, NVLabel3D, NVLabel3DStyle, NVMesh, NVMeshFromUrlOptions, NVMeshLayerDefaults, NVMeshLoaders, NVMeshUtilities, NVUtilities, type NiftiHeader, type NiiVueLocation, type NiiVueLocationValue, Niivue, type Point, SHOW_RENDER, SLICE_TYPE, type Scene, type Volume, cmapper, ColorTables as colortables };
+export { type Connectome, type ConnectomeOptions, DEFAULT_OPTIONS, DRAG_MODE, type DocumentData, type DragReleaseParams, type ExportDocumentData, INITIAL_SCENE_DATA, LabelAnchorPoint, LabelLineTerminator, LabelTextAlignment, type LegacyConnectome, type LegacyNodes, MULTIPLANAR_TYPE, type NVConfigOptions, type NVConnectomeEdge, type NVConnectomeNode, NVController, NVDocument, NVImage, NVImageFromUrlOptions, NVLabel3D, NVLabel3DStyle, NVMesh, NVMeshFromUrlOptions, NVMeshLayerDefaults, NVMeshLoaders, NVMeshUtilities, NVUtilities, type NiftiHeader, type NiiVueLocation, type NiiVueLocationValue, Niivue, type Point, SHOW_RENDER, SLICE_TYPE, type Scene, type Volume, cmapper, ColorTables as colortables };