fix(types): fix the signature of resize method (#630)

* fix(renderingEngine): fix the signature of resize method * Update API documentation
cornerstonejs · Jun 14, 2023 · 7b6f855 · 7b6f855
1 parent 24ae3c9
commit 7b6f855
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/common/reviews/api/core.api.md b/common/reviews/api/core.api.md
@@ -1532,7 +1532,7 @@ interface IRenderingEngine {
     // (undocumented)
     renderViewports(viewportIds: Array<string>): void;
     // (undocumented)
-    resize(immediate?: boolean, resetPan?: boolean, resetZoom?: boolean): void;
+    resize(immediate?: boolean, keepCamera?: boolean): void;
     // (undocumented)
     setViewports(viewports: Array<PublicViewportInput>): void;
 }

diff --git a/common/reviews/api/streaming-image-volume-loader.api.md b/common/reviews/api/streaming-image-volume-loader.api.md
@@ -1064,7 +1064,7 @@ interface IRenderingEngine {
     // (undocumented)
     renderViewports(viewportIds: Array<string>): void;
     // (undocumented)
-    resize(immediate?: boolean, resetPan?: boolean, resetZoom?: boolean): void;
+    resize(immediate?: boolean, keepCamera?: boolean): void;
     // (undocumented)
     setViewports(viewports: Array<PublicViewportInput>): void;
 }

diff --git a/common/reviews/api/tools.api.md b/common/reviews/api/tools.api.md
@@ -2801,7 +2801,7 @@ interface IRenderingEngine {
     // (undocumented)
     renderViewports(viewportIds: Array<string>): void;
     // (undocumented)
-    resize(immediate?: boolean, resetPan?: boolean, resetZoom?: boolean): void;
+    resize(immediate?: boolean, keepCamera?: boolean): void;
     // (undocumented)
     setViewports(viewports: Array<PublicViewportInput>): void;
 }

diff --git a/packages/core/src/types/IRenderingEngine.ts b/packages/core/src/types/IRenderingEngine.ts
@@ -8,7 +8,7 @@ export default interface IRenderingEngine {
   offscreenMultiRenderWindow: any;
   offScreenCanvasContainer: any;
   setViewports(viewports: Array<PublicViewportInput>): void;
-  resize(immediate?: boolean, resetPan?: boolean, resetZoom?: boolean): void;
+  resize(immediate?: boolean, keepCamera?: boolean): void;
   getViewport(id: string): IStackViewport | IVolumeViewport;
   getViewports(): Array<IStackViewport | IVolumeViewport>;
   render(): void;