fix: extract IRenderingEngine type, docs: add documentation search (#70)

* exports IRenderingEngine type * updataed api * add docsearch api keys
cornerstonejs · Apr 11, 2022 · 6a705a8 · 6a705a8
1 parent 08ad542
commit 6a705a8
Show file tree

Hide file tree

Showing 12 changed files with 560 additions and 466 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -6,9 +6,6 @@
   "root": true,
   "parser": "@typescript-eslint/parser",
 
-  // eslint-plugin-react
-  // - react
-  //
   // eslint-plugin-prettier
   // - prettier
   //
@@ -19,7 +16,6 @@
   // eslint-plugin-import
   // - import
   "plugins": [
-    "react",
     "@typescript-eslint",
     "import",
     "eslint-plugin-tsdoc",
@@ -45,8 +41,6 @@
   // -
   "extends": [
     "eslint:recommended",
-    "plugin:react/recommended",
-    "plugin:react-hooks/recommended",
     "plugin:@typescript-eslint/recommended",
     // sets up the plugin AND eslint-config-prettier
     "plugin:prettier/recommended"

diff --git a/common/reviews/api/core.api.md b/common/reviews/api/core.api.md
@@ -1016,7 +1016,7 @@ interface IRenderingEngine {
     // (undocumented)
     renderViewports(viewportIds: Array<string>): void;
     // (undocumented)
-    resize(): void;
+    resize(immediate?: boolean, resetPanZoomForViewPlane?: 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
@@ -743,7 +743,7 @@ interface IRenderingEngine {
     // (undocumented)
     renderViewports(viewportIds: Array<string>): void;
     // (undocumented)
-    resize(): void;
+    resize(immediate?: boolean, resetPanZoomForViewPlane?: boolean): void;
     // (undocumented)
     setViewports(viewports: Array<PublicViewportInput>): void;
 }

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

diff --git a/packages/core/src/RenderingEngine/RenderingEngine.ts b/packages/core/src/RenderingEngine/RenderingEngine.ts
@@ -10,6 +10,7 @@ import viewportTypeUsesCustomRenderingPipeline from './helpers/viewportTypeUsesC
 import getOrCreateCanvas from './helpers/getOrCreateCanvas';
 import { getShouldUseCPURendering, isCornerstoneInitialized } from '../init';
 import type IStackViewport from '../types/IStackViewport';
+import type IRenderingEngine from '../types/IRenderingEngine';
 import type IVolumeViewport from '../types/IVolumeViewport';
 import type * as EventTypes from '../types/EventTypes';
 import type {
@@ -20,31 +21,6 @@ import type {
 } from '../types/IViewport';
 import ORIENTATION from '../constants/orientation';
 
-export interface IRenderingEngine {
-  id: string;
-  hasBeenDestroyed: boolean;
-  offscreenMultiRenderWindow: any;
-  offScreenCanvasContainer: any;
-  setViewports(viewports: Array<PublicViewportInput>): void;
-  resize(): void;
-  getViewport(id: string): IStackViewport | IVolumeViewport;
-  getViewports(): Array<IStackViewport | IVolumeViewport>;
-  render(): void;
-  renderViewports(viewportIds: Array<string>): void;
-  renderViewport(viewportId: string): void;
-  renderFrameOfReference(FrameOfReferenceUID: string): void;
-  fillCanvasWithBackgroundColor(
-    canvas: HTMLCanvasElement,
-    backgroundColor: [number, number, number]
-  ): void;
-  enableElement(viewportInputEntry: PublicViewportInput): void;
-  disableElement(viewportId: string): void;
-  getStackViewports(): Array<IStackViewport>;
-  getVolumeViewports(): Array<IVolumeViewport>;
-  destroy(): void;
-  _debugRender(): void;
-}
-
 type ViewportDisplayCoords = {
   sxStartDisplayCoords: number;
   syStartDisplayCoords: number;

diff --git a/packages/core/src/RenderingEngine/getRenderingEngine.ts b/packages/core/src/RenderingEngine/getRenderingEngine.ts
@@ -1,5 +1,5 @@
 import renderingEngineCache from './renderingEngineCache';
-import type { IRenderingEngine } from './RenderingEngine';
+import type { IRenderingEngine } from '../types';
 
 /**
  * Method to retrieve a RenderingEngine by its unique identifier.

diff --git a/packages/core/src/RenderingEngine/renderingEngineCache.ts b/packages/core/src/RenderingEngine/renderingEngineCache.ts
@@ -1,4 +1,4 @@
-import type { IRenderingEngine } from './RenderingEngine';
+import type { IRenderingEngine } from '../types';
 
 const cache = {};
 

diff --git a/packages/core/src/types/IEnabledElement.ts b/packages/core/src/types/IEnabledElement.ts
@@ -1,4 +1,4 @@
-import type { IRenderingEngine } from '../RenderingEngine/RenderingEngine';
+import type { IRenderingEngine } from '../types';
 import type IStackViewport from './IStackViewport';
 import type IVolumeViewport from './IVolumeViewport';
 

diff --git a/packages/core/src/types/IRenderingEngine.ts b/packages/core/src/types/IRenderingEngine.ts
@@ -0,0 +1,28 @@
+import IStackViewport from './IStackViewport';
+import { PublicViewportInput } from './IViewport';
+import IVolumeViewport from './IVolumeViewport';
+
+export default interface IRenderingEngine {
+  id: string;
+  hasBeenDestroyed: boolean;
+  offscreenMultiRenderWindow: any;
+  offScreenCanvasContainer: any;
+  setViewports(viewports: Array<PublicViewportInput>): void;
+  resize(immediate?: boolean, resetPanZoomForViewPlane?: boolean): void;
+  getViewport(id: string): IStackViewport | IVolumeViewport;
+  getViewports(): Array<IStackViewport | IVolumeViewport>;
+  render(): void;
+  renderViewports(viewportIds: Array<string>): void;
+  renderViewport(viewportId: string): void;
+  renderFrameOfReference(FrameOfReferenceUID: string): void;
+  fillCanvasWithBackgroundColor(
+    canvas: HTMLCanvasElement,
+    backgroundColor: [number, number, number]
+  ): void;
+  enableElement(viewportInputEntry: PublicViewportInput): void;
+  disableElement(viewportId: string): void;
+  getStackViewports(): Array<IStackViewport>;
+  getVolumeViewports(): Array<IVolumeViewport>;
+  destroy(): void;
+  _debugRender(): void;
+}
diff --git a/packages/core/src/types/index.ts b/packages/core/src/types/index.ts
@@ -53,7 +53,7 @@ import type CPUFallbackLUT from './CPUFallbackLUT';
 import type CPUFallbackRenderingTools from './CPUFallbackRenderingTools';
 import type { IVolumeInput, VolumeInputCallback } from './IVolumeInput';
 import type * as EventTypes from './EventTypes';
-import type { IRenderingEngine } from '../RenderingEngine/RenderingEngine';
+import type IRenderingEngine from './IRenderingEngine';
 
 export type {
   ICamera,

diff --git a/packages/docs/docusaurus.config.js b/packages/docs/docusaurus.config.js
@@ -14,6 +14,12 @@ module.exports = {
   organizationName: 'CornerstoneJS', // Usually your GitHub org/user name.
   projectName: 'Cornerstone', // Usually your repo name.
   themeConfig: {
+    algolia: {
+      appId: 'OWBKNRE2E5',
+      apiKey: 'e15ff95ce3ebe52c0995b8222b808a18',
+      indexName: 'cornerstonejs',
+      contextualSearch: true,
+    },
     navbar: {
       logo: {
         alt: 'Cornerstone.js',