@niivue/niivue 0.46.0 → 0.48.0

package/build/index.d.ts

@@ -404,7 +404,8 @@ declare class NVImage {
     readMIF(buffer: ArrayBuffer, pairedImgData: ArrayBuffer | null): ArrayBuffer;
     readNRRD(dataBuffer: ArrayBuffer, pairedImgData: ArrayBuffer | null): ArrayBuffer;
     calculateRAS(): void;
-    img2RAS(): TypedVoxelArray;
+    hdr2RAS(nVolumes?: number): nifti.NIFTI1 | nifti.NIFTI2;
+    img2RAS(nVolume?: number): TypedVoxelArray;
     vox2mm(XYZ: number[], mtx: mat4): vec3;
     mm2vox(mm: number[], frac?: boolean): Float32Array | vec3;
     arrayEquals(a: unknown[], b: unknown[]): boolean;
@@ -614,6 +615,7 @@ type NVConfigOptions = {
     textHeight: number;
     colorbarHeight: number;
     crosshairWidth: number;
+    crosshairWidthUnit: 'voxels' | 'mm' | 'percent';
     crosshairGap: number;
     rulerWidth: number;
     show3Dcrosshair: boolean;
@@ -638,6 +640,7 @@ type NVConfigOptions = {
     isRuler: boolean;
     isColorbar: boolean;
     isOrientCube: boolean;
+    tileMargin: number;
     multiplanarPadPixels: number;
     multiplanarForceRender: boolean;
     multiplanarEqualSize: boolean;
@@ -648,6 +651,8 @@ type NVConfigOptions = {
     yoke3Dto2DZoom: boolean;
     isDepthPickMesh: boolean;
     isCornerOrientationText: boolean;
+    heroImageFraction: number;
+    heroSliceType: SLICE_TYPE;
     sagittalNoseLeft: boolean;
     isSliceMM: boolean;
     isV1SliceShader: boolean;
@@ -688,6 +693,11 @@ type NVConfigOptions = {
     selectionBoxLineThickness: number;
     selectionBoxIsOutline: boolean;
     scrollRequiresFocus: boolean;
+    showMeasureUnits: boolean;
+    measureTextJustify: 'start' | 'center' | 'end';
+    measureTextColor: number[];
+    measureLineColor: number[];
+    measureTextHeight: number;
 };
 declare const DEFAULT_OPTIONS: NVConfigOptions;
 type SceneData = {
@@ -2205,6 +2215,13 @@ declare class Niivue {
      * @see {@link https://niivue.github.io/niivue/features/worldspace2.html | live demo usage}
      */
     setCornerOrientationText(isCornerOrientationText: boolean): void;
+    /**
+     * determine proportion of screen real estate devoted to rendering in multiplanar view.
+     * @param fraction - proportion of screen devoted to primary (hero) image (0 to disable)
+     * @example niivue.setHeroImage(0.5)
+     * @see {@link https://niivue.github.io/niivue/features/layout.html | live demo usage}
+     */
+    setHeroImage(fraction: number): void;
     /**
      * control whether 2D slices use radiological or neurological convention.
      * @param isRadiologicalConvention - new display convention
@@ -3028,7 +3045,7 @@ declare class Niivue {
     sumBitmap(img: Uint8Array): number;
     mouseClick(x: number, y: number, posChange?: number, isDelta?: boolean): void;
     drawRuler(): void;
-    drawRuler10cm(startXYendXY: number[]): void;
+    drawRuler10cm(startXYendXY: number[], rulerColor: number[], rulerWidth?: number): void;
     screenXY2mm(x: number, y: number, forceSlice?: number): vec4;
     dragForPanZoom(startXYendXY: number[]): void;
     dragForCenterButton(startXYendXY: number[]): void;
@@ -3119,7 +3136,7 @@ declare class Niivue {
     frac2mm(frac: vec3, volIdx?: number, isForceSliceMM?: boolean): vec4;
     screenXY2TextureFrac(x: number, y: number, i: number, restrict0to1?: boolean): vec3;
     canvasPos2frac(canvasPos: number[]): vec3;
-    scaleSlice(w: number, h: number, widthPadPixels?: number, heightPadPixels?: number): number[];
+    scaleSlice(w: number, h: number, padPixelsWH?: [number, number], canvasWH?: [number, number]): number[];
     drawThumbnail(): void;
     drawLine(startXYendXY: number[], thickness?: number, lineColor?: number[]): void;
     draw3DLine(startXY: vec2, endXYZ: vec3, thickness?: number, lineColor?: number[]): void;