api fix

cornerstonejs · Apr 15, 2024 · d6139f2 · d6139f2
1 parent dc7f748
commit d6139f2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/common/reviews/api/core.api.md b/common/reviews/api/core.api.md
@@ -2094,7 +2094,7 @@ interface IStackViewport extends IViewport {
     // (undocumented)
     setDefaultProperties(ViewportProperties: StackViewportProperties, imageId?: string): void;
     // (undocumented)
-    setImageIdIndex(imageIdIndex: number): Promise<string>;
+    setImageIdIndex(imageIdIndex: number, overwriteScrollIndex?: boolean): Promise<string>;
     // (undocumented)
     setProperties({ voiRange, invert, interpolationType, rotation, colormap, }: StackViewportProperties, suppressEvents?: boolean): void;
     // (undocumented)
@@ -3138,7 +3138,7 @@ export class StackViewport extends Viewport implements IStackViewport, IImagesLo
     // (undocumented)
     setDefaultProperties(ViewportProperties: StackViewportProperties, imageId?: string): void;
     // (undocumented)
-    setImageIdIndex(imageIdIndex: number): Promise<string>;
+    setImageIdIndex(imageIdIndex: number, overwriteScrollIndex?: any): Promise<string>;
     // (undocumented)
     protected setInterpolationType: (interpolationType: InterpolationType) => void;
     // (undocumented)

diff --git a/packages/core/src/RenderingEngine/StackViewport.ts b/packages/core/src/RenderingEngine/StackViewport.ts
@@ -2447,7 +2447,10 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
    * @param imageIdIndex - number represents imageId index
    * @param overwriteScrollIndex - can be used to also set the start position of scroll() to this index
    */
-  private async _setImageIdIndex(imageIdIndex: number, overwriteScrollIndex: boolean = false): Promise<string> {
+  private async _setImageIdIndex(
+    imageIdIndex: number,
+    overwriteScrollIndex?: boolean
+  ): Promise<string> {
     if (imageIdIndex >= this.imageIds.length) {
       throw new Error(
         `ImageIdIndex provided ${imageIdIndex} is invalid, the stack only has ${this.imageIds.length} elements`
@@ -2589,7 +2592,10 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
    * provided imageIds in setStack
    * @param overwriteScrollIndex - can be used to also set the start position of scroll() to this index
    */
-  public setImageIdIndex(imageIdIndex: number, overwriteScrollIndex: boolean = false): Promise<string> {
+  public setImageIdIndex(
+    imageIdIndex: number,
+    overwriteScrollIndex?
+  ): Promise<string> {
     this._throwIfDestroyed();
 
     // If we are already on this imageId index, stop here
@@ -2598,7 +2604,10 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
     }
 
     // Otherwise, get the imageId and attempt to display it
-    const imageIdPromise = this._setImageIdIndex(imageIdIndex, overwriteScrollIndex);
+    const imageIdPromise = this._setImageIdIndex(
+      imageIdIndex,
+      overwriteScrollIndex
+    );
 
     return imageIdPromise;
   }

diff --git a/packages/core/src/types/IStackViewport.ts b/packages/core/src/types/IStackViewport.ts
@@ -160,7 +160,7 @@ export default interface IStackViewport extends IViewport {
    */
   setImageIdIndex(
     imageIdIndex: number,
-    overwriteScrollIndex: boolean
+    overwriteScrollIndex?: boolean
   ): Promise<string>;
   /**
    * Calibrates the image with new metadata that has been added for imageId. To calibrate