@cornerstonejs/core 1.77.13 → 1.78.0

package/src/types/IRenderingEngine.ts

@@ -2,7 +2,6 @@ import IStackViewport from './IStackViewport';
 import { PublicViewportInput } from './IViewport';
 import IVolumeViewport from './IVolumeViewport';
 import { IViewport } from './IViewport';
-import IVideoViewport from './IVideoViewport';
 
 export default interface IRenderingEngine {
   id: string;
@@ -25,7 +24,6 @@ export default interface IRenderingEngine {
   disableElement(viewportId: string): void;
   getStackViewports(): Array<IStackViewport>;
   getVolumeViewports(): Array<IVolumeViewport>;
-  getVideoViewports(): Array<IVideoViewport>;
   destroy(): void;
   _debugRender(): void;
 }

package/src/types/IViewport.ts

@@ -217,6 +217,18 @@ export type ViewPresentationSelector = {
   paletteLut?: boolean;
 };
 
+export type DataSetOptions = {
+  /**
+   * The group id is a volume, display set or other identification for the
+   * overall set of data.  If set, then two sets of images can be compared for
+   * equality by comparing the group id.
+   * For volumes, if set, the groupId must be the primary volumeId.
+   */
+  groupId?: string;
+  viewSelector?: ViewPresentationSelector;
+  viewReference?: ViewReferenceSpecifier;
+};
+
 /**
  * Viewport interface for cornerstone viewports
  */
@@ -407,6 +419,14 @@ interface IViewport {
 
   _getCorners(bounds: Array<number>): Array<number>[];
   updateRenderingPipeline: () => void;
+  getTargetId?: () => string;
+
+  /**
+   * This is a wrapper for setVideo to allow generic behaviour
+   * @param dataIds - a set of data ids that make up the data viewport
+   * @param options - an optional object with view reference/specifier
+   */
+  setDataIds(dataIds: string[], options?: DataSetOptions): void;
 }
 
 /**

package/src/types/IWSIViewport.ts

@@ -0,0 +1,59 @@
+import { IViewport } from './IViewport';
+import WSIViewportProperties from './WSIViewportProperties';
+
+/**
+ * Interface for Stack Viewport
+ */
+export default interface IWSIViewport extends IViewport {
+  /**
+   * Resizes the viewport - only used in CPU fallback for StackViewport. The
+   * GPU resizing happens inside the RenderingEngine.
+   */
+  resize: () => void;
+  /**
+   * Sets the properties for the viewport on the default actor.
+   */
+  setProperties(props: WSIViewportProperties, suppressEvents?: boolean): void;
+  /**
+   * Retrieve the viewport properties
+   */
+  getProperties: () => WSIViewportProperties;
+
+  /**
+   * Sets the WSI to play.
+   * The WSI should have at least some metadata in the metadata provider,
+   * including:
+   *   * study/series/sop common module for UIDs
+   *   * `cineModule` for information on number of frames and playback rate
+   *   * `imageUrlModule` - to get the URL for the image under the `rendered` attribute
+   *
+   * Without these, other tools requiring metadata wont work, although basic
+   * playback does work if the setWSIURL is used instead.
+   */
+  setWSI: (imageIds: string[], client) => Promise<unknown>;
+
+  /**
+   * Reset the viewport properties to the default values
+   */
+  resetProperties(): void;
+
+  /**
+   * Gets the current image id, including frame selction or frameless.
+   */
+  getCurrentImageId(): string;
+
+  /**
+   * Gets the current frame, 1 based
+   */
+  getFrameNumber(): number;
+
+  /**
+   * Sets the current frame
+   */
+  setFrameNumber(frameNo: number);
+
+  /**
+   * Centers Pan and resets the zoom for stack viewport.
+   */
+  resetCamera(resetPan?: boolean, resetZoom?: boolean): boolean;
+}

package/src/types/WSIViewportProperties.ts

@@ -0,0 +1,8 @@
+import { ViewportProperties } from './ViewportProperties';
+
+/**
+ * WSI Viewport Properties
+ */
+export type WSIViewportProperties = ViewportProperties;
+
+export default WSIViewportProperties;

package/src/types/WSIViewportTypes.ts

@@ -0,0 +1,14 @@
+import { ViewportType } from '../enums';
+
+export type WSIViewportInput = {
+  id: string;
+  renderingEngineId: string;
+  type: ViewportType;
+  element: HTMLDivElement;
+  sx: number;
+  sy: number;
+  sWidth: number;
+  sHeight: number;
+  defaultOptions: any;
+  canvas: HTMLCanvasElement;
+};

package/src/types/index.ts

@@ -17,6 +17,7 @@ import type {
   IViewport,
   PublicViewportInput,
   ViewReferenceSpecifier,
+  DataSetOptions,
   ReferenceCompatibleOptions,
   ViewReference,
   ViewPresentation,
@@ -63,6 +64,7 @@ import type FlipDirection from './FlipDirection';
 import type ICachedImage from './ICachedImage';
 import type ICachedVolume from './ICachedVolume';
 import type IStackViewport from './IStackViewport';
+import type IWSIViewport from './IWSIViewport';
 import type IVolumeViewport from './IVolumeViewport';
 import type ViewportPreset from './ViewportPreset';
 
@@ -116,11 +118,13 @@ export type {
 import type { ImageLoadListener } from './ImageLoadListener';
 import type { Color, ColorLUT } from './Color';
 import type VideoViewportProperties from './VideoViewportProperties';
+import type WSIViewportProperties from './WSIViewportProperties';
 import type IVideoViewport from './IVideoViewport';
 import type {
   InternalVideoCamera,
   VideoViewportInput,
 } from './VideoViewportTypes';
+import { WSIViewportInput } from './WSIViewportTypes';
 import { ISurface } from './ISurface';
 import type BoundsIJK from './BoundsIJK';
 import type { ImageVolumeProps } from './ImageVolumeProps';
@@ -137,6 +141,7 @@ export type {
   ICamera,
   IStackViewport,
   IVideoViewport,
+  IWSIViewport,
   IVolumeViewport,
   IEnabledElement,
   ICache,
@@ -163,6 +168,7 @@ export type {
   IStreamingVolumeProperties,
   IViewport,
   ViewReference,
+  DataSetOptions as ImageSetOptions,
   ViewPresentation,
   ViewPresentationSelector,
   ReferenceCompatibleOptions,
@@ -196,6 +202,7 @@ export type {
   Plane,
   ViewportInputOptions,
   VideoViewportProperties,
+  WSIViewportProperties,
   VOIRange,
   VOI,
   DisplayArea,
@@ -246,6 +253,7 @@ export type {
   // video
   InternalVideoCamera,
   VideoViewportInput,
+  WSIViewportInput,
   BoundsIJK,
   BoundsLPS,
   Color,

package/src/utilities/genericMetadataProvider.ts

@@ -17,8 +17,9 @@ const metadataProvider = {
       state[imageId] = {};
     }
 
-    // Create a deep copy of payload.metadata
-    state[imageId][type] = JSON.parse(JSON.stringify(payload.metadata));
+    // Use the raw metadata, or create a deep copy of payload.metadata
+    state[imageId][type] =
+      payload.rawMetadata ?? structuredClone(payload.metadata);
   },
 
   /**

package/src/utilities/uuidv4.ts

@@ -1,5 +1,3 @@
-// prettier-ignore
-// @ts-nocheck
 /**
  * Generates a unique id that has limited chance of collision
  *
@@ -7,7 +5,5 @@
  * @returns a v4 compliant GUID
  */
 export default function uuidv4(): string {
-  return ([1e7]+-1e3+-4e3+-8e3+-1e11).replace(/[018]/g, c =>
-    (c ^ crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> c / 4).toString(16)
-  );
+  return crypto.randomUUID();
 }