@niivue/niivue 0.53.1 → 0.55.0

package/build/index.d.ts

@@ -683,6 +683,8 @@ declare enum COLORMAP_TYPE {
 type NVConfigOptions = {
     textHeight: number;
     colorbarHeight: number;
+    colorbarWidth: number;
+    showColorbarBorder: boolean;
     crosshairWidth: number;
     crosshairWidthUnit: 'voxels' | 'mm' | 'percent';
     crosshairGap: number;
@@ -721,6 +723,7 @@ type NVConfigOptions = {
     yoke3Dto2DZoom: boolean;
     isDepthPickMesh: boolean;
     isCornerOrientationText: boolean;
+    isOrientationTextVisible: boolean;
     heroImageFraction: number;
     heroSliceType: SLICE_TYPE;
     sagittalNoseLeft: boolean;
@@ -772,6 +775,7 @@ type NVConfigOptions = {
     isAlphaClipDark: boolean;
     gradientOrder: number;
     gradientOpacity: number;
+    gradientAmount: number;
     invertScrollDirection: boolean;
 };
 declare const DEFAULT_OPTIONS: NVConfigOptions;
@@ -2110,6 +2114,12 @@ declare class Niivue {
      * @see {@link https://niivue.github.io/niivue/features/worldspace2.html | live demo usage}
      */
     setCornerOrientationText(isCornerOrientationText: boolean): void;
+    /**
+     * determine if orientation text appears in 2D slice view.
+     * @param isOrientationTextVisible - controls position of text
+     * @example niivue.setIsOrientationTextVisible(false)
+     */
+    setIsOrientationTextVisible(isOrientationTextVisible: 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)

package/build/index.js

@@ -17,7 +17,7 @@ var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "
 import { mat4 as mat49, vec2, vec3 as vec314, vec4 as vec49 } from "gl-matrix";
 
 // package.json
-var version = "0.53.1";
+var version = "0.55.0";
 
 // src/logger.ts
 var _Log = class _Log {
@@ -20386,6 +20386,10 @@ var COLORMAP_TYPE = /* @__PURE__ */ ((COLORMAP_TYPE2) => {
 var DEFAULT_OPTIONS = {
   textHeight: 0.06,
   colorbarHeight: 0.05,
+  colorbarWidth: -1,
+  // automatic (full width)
+  showColorbarBorder: true,
+  // show border around the colorbar
   crosshairWidth: 1,
   crosshairWidthUnit: "voxels",
   crosshairGap: 0,
@@ -20427,6 +20431,7 @@ var DEFAULT_OPTIONS = {
   yoke3Dto2DZoom: false,
   isDepthPickMesh: false,
   isCornerOrientationText: false,
+  isOrientationTextVisible: true,
   heroImageFraction: 0,
   heroSliceType: 4 /* RENDER */,
   sagittalNoseLeft: false,
@@ -20492,6 +20497,7 @@ var DEFAULT_OPTIONS = {
   isAlphaClipDark: false,
   gradientOrder: 1,
   gradientOpacity: 0,
+  gradientAmount: 0,
   invertScrollDirection: false
 };
 var INITIAL_SCENE_DATA = {
@@ -27095,6 +27101,15 @@ var Niivue = class {
     this.opts.isCornerOrientationText = isCornerOrientationText;
     this.updateGLVolume();
   }
+  /**
+   * determine if orientation text appears in 2D slice view.
+   * @param isOrientationTextVisible - controls position of text
+   * @example niivue.setIsOrientationTextVisible(false)
+   */
+  setIsOrientationTextVisible(isOrientationTextVisible) {
+    this.opts.isOrientationTextVisible = isOrientationTextVisible;
+    this.drawScene();
+  }
   /**
    * 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)
@@ -28286,10 +28301,13 @@ var Niivue = class {
     this.renderShader = this.renderVolumeShader;
     if (this.renderGradientValues) {
       this.renderShader = this.renderGradientValuesShader;
-    } else if (gradientAmount > 0 || this.opts.gradientOpacity > 0) {
-      this.renderShader = this.renderGradientShader;
-    } else if (gradientAmount < 0) {
-      this.renderShader = this.renderSliceShader;
+    } else {
+      this.opts.gradientAmount = gradientAmount;
+      if (gradientAmount > 0 || this.opts.gradientOpacity > 0) {
+        this.renderShader = this.renderGradientShader;
+      } else if (gradientAmount < 0) {
+        this.renderShader = this.renderSliceShader;
+      }
     }
     this.initRenderShader(this.renderShader, gradientAmount);
     this.renderShader.use(this.gl);
@@ -28323,6 +28341,9 @@ var Niivue = class {
     }
     this.initRenderShader(this.renderShader, this.gradientTextureAmount);
     this.renderShader.use(this.gl);
+    if (this.gradientTextureAmount > 0) {
+      this.refreshLayers(this.volumes[0], 0);
+    }
     this.drawScene();
   }
   // not included in public docs.
@@ -28481,6 +28502,8 @@ var Niivue = class {
         this.refreshDrawing();
       }
     }
+    await this.setGradientOpacity(this.opts.gradientOpacity);
+    await this.setVolumeRenderIllumination(this.opts.gradientAmount);
     this.updateGLVolume();
     this.drawScene();
     this.onDocumentLoaded(document2);
@@ -32771,7 +32794,15 @@ var Niivue = class {
     let txtHt = Math.max(this.opts.textHeight, 0.01);
     txtHt = txtHt * Math.min(this.gl.canvas.height, this.gl.canvas.width);
     const fullHt = 3 * txtHt;
-    const leftTopWidthHeight = [0, this.gl.canvas.height - fullHt, this.gl.canvas.width, fullHt];
+    const widthPercentage = this.opts.colorbarWidth > 0 && this.opts.colorbarWidth <= 1 ? this.opts.colorbarWidth : 1;
+    const width = widthPercentage * this.gl.canvas.width;
+    const leftTopWidthHeight = [
+      (this.gl.canvas.width - width) / 2,
+      // Center the colorbar horizontally
+      this.gl.canvas.height - fullHt,
+      width,
+      fullHt
+    ];
     this.colorbarHeight = leftTopWidthHeight[3] + 1;
     return leftTopWidthHeight;
   }
@@ -32797,7 +32828,9 @@ var Niivue = class {
     this.colorbarHeight = leftTopWidthHeight[3] + 1;
     const barLTWH = [leftTopWidthHeight[0] + margin, leftTopWidthHeight[1], leftTopWidthHeight[2] - 2 * margin, barHt];
     const rimLTWH = [barLTWH[0] - 1, barLTWH[1] - 1, barLTWH[2] + 2, barLTWH[3] + 2];
-    this.drawRect(rimLTWH, this.opts.crosshairColor);
+    if (this.opts.showColorbarBorder) {
+      this.drawRect(rimLTWH, this.opts.crosshairColor);
+    }
     if (!this.colorbarShader) {
       throw new Error("colorbarShader undefined");
     }
@@ -33458,7 +33491,7 @@ var Niivue = class {
     if (isNaN(customMM)) {
       this.drawCrosshairs3D(false, 0.15, obj.modelViewProjectionMatrix, true, this.opts.isSliceMM);
     }
-    if (isStretchToScreen) {
+    if (isStretchToScreen && this.opts.isOrientationTextVisible) {
       this.drawSliceOrientationText(leftTopWidthHeight, axCorSag);
     }
     this.readyForSync = true;
@@ -33492,7 +33525,7 @@ var Niivue = class {
     if (customMM === Infinity || customMM === -Infinity || axCorSag === 4 /* RENDER */) {
       return;
     }
-    if (leftTopWidthHeight[2] !== 0 && leftTopWidthHeight[3] !== 0) {
+    if (leftTopWidthHeight[2] !== 0 && leftTopWidthHeight[3] !== 0 && this.opts.isOrientationTextVisible) {
       this.drawSliceOrientationText(leftTopWidthHeight, axCorSag, padLeftTop);
     }
   }