@niivue/niivue 0.43.1 → 0.43.3

package/build/index.d.ts

@@ -215,11 +215,12 @@ type ImageFromUrlOptions = {
     ignoreZeroVoxels?: boolean;
     imageType?: ImageType;
     frame4D?: number;
-    colormapLabel?: string[];
+    colormapLabel?: LUT | null;
     pairedImgData?: null;
     limitFrames4D?: number;
     isManifest?: boolean;
     urlImgData?: string;
+    buffer?: ArrayBuffer;
 };
 type ImageFromFileOptions = {
     file: File | File[];
@@ -248,6 +249,14 @@ type ImageFromBase64 = {
     trustCalMinMax?: boolean;
     percentileFrac?: number;
     ignoreZeroVoxels?: boolean;
+    useQFormNotSForm?: boolean;
+    colormapNegative?: string;
+    frame4D?: number;
+    imageType?: ImageType;
+    cal_minNeg?: number;
+    cal_maxNeg?: number;
+    colorbarVisible?: boolean;
+    colormapLabel?: LUT | null;
 };
 type ImageMetadata = {
     id: string;
@@ -262,7 +271,7 @@ type ImageMetadata = {
     dt: number;
     bpv: number;
 };
-declare const NVImageFromUrlOptions: (url: string, urlImageData?: string, name?: string, colormap?: string, opacity?: number, cal_min?: number, cal_max?: number, trustCalMinMax?: boolean, percentileFrac?: number, ignoreZeroVoxels?: boolean, useQFormNotSForm?: boolean, colormapNegative?: string, frame4D?: number, imageType?: ImageType, cal_minNeg?: number, cal_maxNeg?: number, colorbarVisible?: boolean, alphaThreshold?: boolean, colormapLabel?: string[]) => ImageFromUrlOptions;
+declare const NVImageFromUrlOptions: (url: string, urlImageData?: string, name?: string, colormap?: string, opacity?: number, cal_min?: number, cal_max?: number, trustCalMinMax?: boolean, percentileFrac?: number, ignoreZeroVoxels?: boolean, useQFormNotSForm?: boolean, colormapNegative?: string, frame4D?: number, imageType?: ImageType, cal_minNeg?: number, cal_maxNeg?: number, colorbarVisible?: boolean, alphaThreshold?: boolean, colormapLabel?: null) => ImageFromUrlOptions;
 
 type TypedVoxelArray = Float32Array | Uint8Array | Int16Array | Float64Array | Uint16Array;
 /**
@@ -397,7 +406,7 @@ declare class NVImage {
      * factory function to load and return a new NVImage instance from a given URL
      * @returns  NVImage instance
      */
-    static loadFromUrl({ url, urlImgData, headers, name, colormap, opacity, cal_min, cal_max, trustCalMinMax, percentileFrac, ignoreZeroVoxels, useQFormNotSForm, colormapNegative, frame4D, isManifest, limitFrames4D, imageType, colorbarVisible }?: Partial<Omit<ImageFromUrlOptions, 'url'>> & {
+    static loadFromUrl({ url, urlImgData, headers, name, colormap, opacity, cal_min, cal_max, trustCalMinMax, percentileFrac, ignoreZeroVoxels, useQFormNotSForm, colormapNegative, frame4D, isManifest, limitFrames4D, imageType, colorbarVisible, buffer }?: Partial<Omit<ImageFromUrlOptions, 'url'>> & {
         url?: string | Uint8Array | ArrayBuffer;
     }): Promise<NVImage>;
     static readFileAsync(file: File, bytesToLoad?: number): Promise<ArrayBuffer>;
@@ -440,7 +449,7 @@ declare class NVImage {
      * @example
      * myImage = NVImage.loadFromBase64('SomeBase64String')
      */
-    static loadFromBase64({ base64, name, colormap, opacity, cal_min, cal_max, trustCalMinMax, percentileFrac, ignoreZeroVoxels }: ImageFromBase64): NVImage;
+    static loadFromBase64({ base64, name, colormap, opacity, cal_min, cal_max, trustCalMinMax, percentileFrac, ignoreZeroVoxels, useQFormNotSForm, colormapNegative, frame4D, imageType, cal_minNeg, cal_maxNeg, colorbarVisible, colormapLabel }: ImageFromBase64): NVImage;
     /**
      * make a clone of a NVImage instance and return a new NVImage
      * @returns NVImage instance
@@ -672,6 +681,7 @@ type DocumentData = {
     meshesString?: string;
     sceneData?: SceneData;
     connectomes?: string[];
+    customData?: string;
 };
 type ExportDocumentData = {
     encodedImageBlobs: string[];
@@ -684,6 +694,7 @@ type ExportDocumentData = {
     meshesString: string;
     labels: NVLabel3D[];
     connectomes: string[];
+    customData: string;
 };
 /**
  * Creates and instance of NVDocument
@@ -743,6 +754,8 @@ declare class NVDocument {
      * Sets the 3D labels of the {@link Niivue} instance
      */
     set labels(labels: NVLabel3D[]);
+    get customData(): string | undefined;
+    set customData(data: string);
     /**
      * Checks if document has an image by id
      */
@@ -989,26 +1002,38 @@ type NVMeshLayer = {
     headers?: Record<string, string>;
     opacity: number;
     colormap: string;
-    colormapNegative: string;
-    colormapInvert: boolean;
+    colormapNegative?: string;
+    colormapInvert?: boolean;
     colormapLabel?: ColorMap | LUT;
-    useNegativeCmap: boolean;
-    global_min: number;
-    global_max: number;
+    useNegativeCmap?: boolean;
+    global_min?: number;
+    global_max?: number;
     cal_min: number;
     cal_max: number;
     cal_minNeg: number;
     cal_maxNeg: number;
-    isAdditiveBlend: boolean;
+    isAdditiveBlend?: boolean;
     frame4D: number;
     nFrame4D: number;
-    values: number[];
+    values: AnyNumberArray;
     outlineBorder?: number;
     isTransparentBelowCalMin?: boolean;
-    alphaThreshold: boolean;
+    alphaThreshold?: boolean;
     base64?: string;
     colorbarVisible?: boolean;
 };
+declare const NVMeshLayerDefaults: {
+    colormap: string;
+    opacity: number;
+    nFrame4D: number;
+    frame4D: number;
+    outlineBorder: number;
+    cal_min: number;
+    cal_max: number;
+    cal_minNeg: number;
+    cal_maxNeg: number;
+    values: number[];
+};
 declare class NVMeshFromUrlOptions {
     url: string;
     gl: WebGL2RenderingContext | null;
@@ -1031,6 +1056,7 @@ type BaseLoadParams = {
 type LoadFromUrlParams = Partial<BaseLoadParams> & {
     url: string;
     headers?: Record<string, string>;
+    buffer?: ArrayBuffer;
 };
 type LoadFromFileParams = BaseLoadParams & {
     file: Blob;
@@ -1126,7 +1152,7 @@ declare class NVMesh {
     /**
      * factory function to load and return a new NVMesh instance from a given URL
      */
-    static loadFromUrl({ url, headers, gl, name, opacity, rgba255, visible, layers }?: Partial<LoadFromUrlParams>): Promise<NVMesh>;
+    static loadFromUrl({ url, headers, gl, name, opacity, rgba255, visible, layers, buffer }?: Partial<LoadFromUrlParams>): Promise<NVMesh>;
     static readFileAsync(file: Blob): Promise<ArrayBuffer>;
     /**
      * factory function to load and return a new NVMesh instance from a file in the browser
@@ -1422,7 +1448,7 @@ declare class NVMeshLoaders {
     static readTCK(buffer: ArrayBuffer): TCK;
     static readTRK(buffer: ArrayBuffer): TRK;
     static readTxtVTK(buffer: ArrayBuffer): VTK;
-    static readLayer(name: string | undefined, buffer: ArrayBuffer, nvmesh: NVMesh, opacity?: number, colormap?: string, colormapNegative?: string, useNegativeCmap?: boolean, cal_min?: number | null, cal_max?: number | null, outlineBorder?: number): void;
+    static readLayer(name: string | undefined, 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 readCURV(buffer: ArrayBuffer, n_vert: number): Float32Array;
@@ -1991,6 +2017,18 @@ declare class Niivue {
      * @param url - filename
      */
     isMeshExt(url: string): boolean;
+    /**
+     * Load an image or mesh from an array buffer
+     * @param buffer - ArrayBuffer with the entire contents of a mesh or volume
+     * @param name - string of filename, extension used to infer type (NIfTI, MGH, MZ3, etc)
+     * @see {@link http://192.168.0.150:8080/features/draganddrop.html | live demo usage}
+     */
+    loadFromArrayBuffer(buffer: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Load a mesh or image from a file object
+     * @param file - File object
+     */
+    loadFromFile(file: File): Promise<void>;
     dropListener(e: DragEvent): void;
     /**
      * insert a gap between slices of a mutliplanar view.
@@ -2703,9 +2741,10 @@ declare class Niivue {
      * @param toRAS - reslice to row, column slices to right-anterior-superior not left-inferior-anterior (default false).
      * @param isLinear - reslice with linear rather than nearest-neighbor interpolation (default true).
      * @param asFloat32 - use Float32 datatype rather than Uint8 (default false).
+     * @param isRobustMinMax - clamp intensity with robust min max (~2%..98%) instead of FreeSurfer (0%..99.99%) (default false).
      * @see {@link https://niivue.github.io/niivue/features/torso.html | live demo usage}
      */
-    conform(volume: NVImage, toRAS?: boolean, isLinear?: boolean, asFloat32?: boolean): Promise<NVImage>;
+    conform(volume: NVImage, toRAS?: boolean, isLinear?: boolean, asFloat32?: boolean, isRobustMinMax?: boolean): Promise<NVImage>;
     /**
      * darken crevices and brighten corners when 3D rendering drawings.
      * @param amount - amount of ambient occlusion (default 0.4)
@@ -2882,4 +2921,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, NVMeshLoaders, NVUtilities, type NiftiHeader, Niivue, type Point, 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, LabelLineTerminator, LabelTextAlignment, type LegacyConnectome, type LegacyNodes, MULTIPLANAR_TYPE, type NVConfigOptions, type NVConnectomeEdge, type NVConnectomeNode, NVController, NVDocument, NVImage, NVImageFromUrlOptions, NVLabel3D, NVLabel3DStyle, NVMesh, NVMeshFromUrlOptions, NVMeshLayerDefaults, NVMeshLoaders, NVUtilities, type NiftiHeader, Niivue, type Point, SLICE_TYPE, type Scene, type Volume, cmapper, ColorTables as colortables };