@cornerstonejs/core 5.0.16 → 5.1.0

package/dist/esm/RenderingEngine/BaseVolumeViewport.d.ts

@@ -65,6 +65,10 @@ declare abstract class BaseVolumeViewport extends Viewport {
     getProperties: (volumeId?: string) => VolumeViewportProperties | undefined | null;
     private getColormap;
     setVolumes(volumeInputArray: IVolumeInput[], immediate?: boolean, suppressEvents?: boolean): Promise<void>;
+    setDisplaySets(...entries: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>): Promise<void>;
     addVolumes(volumeInputArray: IVolumeInput[], immediate?: boolean, suppressEvents?: boolean): Promise<void>;
     removeVolumeActors(actorUIDs: string[], immediate?: boolean): void;
     setOrientation(_orientation: OrientationAxis | OrientationVectors, _immediate?: boolean, _suppressEvents?: boolean): void;

package/dist/esm/RenderingEngine/BaseVolumeViewport.js

@@ -14,6 +14,9 @@ import transformWorldToIndex from '../utilities/transformWorldToIndex';
 import { findMatchingColormap, updateOpacity as colormapUpdateOpacity, updateThreshold as colormapUpdateThreshold, updateOpacityMapping as colormapUpdateOpacityMapping, getOpacityState, } from '../utilities/colormap';
 import getAcquisitionPlaneOrientation from '../utilities/getAcquisitionPlaneOrientation';
 import { getTransferFunctionNodes, setTransferFunctionNodes, } from '../utilities/transferFunctionUtils';
+import { createAndCacheVolume } from '../loaders/volumeLoader';
+import resolveViewportVolumeId from './helpers/resolveViewportVolumeId';
+import { getGenericViewportImageDisplaySet } from './GenericViewport/genericViewportDisplaySetAccess';
 import createVolumeActor from './helpers/createVolumeActor';
 import volumeNewImageEventDispatcher, { resetVolumeNewImageState, } from './helpers/volumeNewImageEventDispatcher';
 import Viewport from './Viewport';
@@ -912,6 +915,7 @@ class BaseVolumeViewport extends Viewport {
     }
     setSampleDistanceMultiplier(multiplier) { }
     async setVolumes(volumeInputArray, immediate = false, suppressEvents = false) {
+        this.clearDisplaySets();
         const volumeId = volumeInputArray[0].volumeId;
         const firstImageVolume = cache.getVolume(volumeId);
         if (!firstImageVolume) {
@@ -947,6 +951,26 @@ class BaseVolumeViewport extends Viewport {
             this.render();
         }
     }
+    async setDisplaySets(...entries) {
+        await this.mountDisplaySets(entries, async (entry) => {
+            const dataSet = getGenericViewportImageDisplaySet(entry.displaySetId);
+            if (!dataSet?.imageIds?.length) {
+                throw new Error(`[VolumeViewport] No registered imageIds for display set ${entry.displaySetId}`);
+            }
+            const volumeId = resolveViewportVolumeId(dataSet.volumeId ?? entry.displaySetId);
+            if (!cache.getVolume(volumeId)) {
+                const volume = await createAndCacheVolume(volumeId, {
+                    imageIds: dataSet.imageIds,
+                });
+                volume.load();
+            }
+            const volumeInput = {
+                volumeId,
+                ...(entry.options ?? {}),
+            };
+            await this.setVolumes([volumeInput]);
+        });
+    }
     async addVolumes(volumeInputArray, immediate = false, suppressEvents = false) {
         const firstImageVolume = cache.getVolume(volumeInputArray[0].volumeId);
         if (!firstImageVolume) {

package/dist/esm/RenderingEngine/ECGViewport.d.ts

@@ -19,6 +19,10 @@ declare class ECGViewport extends Viewport {
     private removeEventListeners;
     private elementDisabledHandler;
     setEcg(imageId: string): Promise<void>;
+    setDisplaySets(...entries: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>): Promise<void>;
     setChannelVisibility(index: number, visible: boolean): void;
     getVisibleChannels(): {
         name: string;

package/dist/esm/RenderingEngine/ECGViewport.js

@@ -3,6 +3,7 @@ import { Transform } from './helpers/cpuFallback/rendering/transform';
 import triggerEvent from '../utilities/triggerEvent';
 import Viewport from './Viewport';
 import { getOrCreateCanvas } from './helpers';
+import { getGenericViewportSourceDataId } from './GenericViewport/genericViewportDisplaySetAccess';
 import { ECG_CHANNEL_SPACING, computeECGChannelLayouts, computeECGHeight, drawECGGrid, drawECGLabels, drawECGTraces, ECG_RENDERING_COLORS, ECG_SECONDS_WIDTH, getVisibleECGChannelsByFlag, loadECGWaveform, } from '../utilities/ECGUtilities';
 const ECG_AMPLITUDE_INDEX_SIZE = 65536;
 class ECGViewport extends Viewport {
@@ -173,6 +174,7 @@ class ECGViewport extends Viewport {
         this.removeEventListeners();
     }
     async setEcg(imageId) {
+        this.clearDisplaySets();
         this.imageId = imageId;
         const { waveform, calibration } = await loadECGWaveform(imageId);
         this.channels = waveform.channels.map((channel) => ({
@@ -192,6 +194,12 @@ class ECGViewport extends Viewport {
         this.refreshRenderValues();
         this.renderFrame();
     }
+    async setDisplaySets(...entries) {
+        await this.mountDisplaySets(entries, async (entry) => {
+            const sourceDataId = getGenericViewportSourceDataId(entry.displaySetId);
+            await this.setEcg(sourceDataId);
+        });
+    }
     setChannelVisibility(index, visible) {
         if (index >= 0 && index < this.channels.length) {
             this.channels[index].visible = visible;

package/dist/esm/RenderingEngine/GenericViewport/ECG/DefaultECGDataProvider.js

@@ -1,5 +1,5 @@
 import { loadECGWaveform } from '../../../utilities/ECGUtilities';
-import { getGenericViewportSourceDataId } from '../genericViewportDataSetAccess';
+import { getGenericViewportSourceDataId } from '../genericViewportDisplaySetAccess';
 export class DefaultECGDataProvider {
     async load(dataId) {
         const sourceDataId = getGenericViewportSourceDataId(dataId);

package/dist/esm/RenderingEngine/GenericViewport/GenericViewport.d.ts

@@ -1,7 +1,7 @@
 import type ICamera from '../../types/ICamera';
 import type { Point2, Point3 } from '../../types';
 import ViewportStatus from '../../enums/ViewportStatus';
-import type { BaseViewportRenderContext, BindingRole, DataAddOptions, DataId, DataProvider, LoadedData, ViewportDataBinding, RenderPathResolver, ViewportController, ViewportId } from './ViewportArchitectureTypes';
+import type { BaseViewportRenderContext, BindingRole, DataAddOptions, DisplaySetId, DataProvider, LoadedData, ViewportDataBinding, RenderPathResolver, ViewportController, ViewportId } from './ViewportArchitectureTypes';
 import type ViewportType from '../../enums/ViewportType';
 import type ResolvedViewportView from './ResolvedViewportView';
 import type { ReferenceCompatibleOptions, ViewReference, ViewReferenceSpecifier, RenderingEngineResizeOptions } from '../../types/IViewport';
@@ -27,14 +27,18 @@ declare abstract class GenericViewport<TViewState extends object, TDataPresentat
         element: HTMLDivElement;
     });
     setDisplaySets(...entries: Array<{
-        displaySetId: DataId;
+        displaySetId: DisplaySetId;
         options?: unknown;
     }>): Promise<void>;
-    addDisplaySet(displaySetId: DataId, options: DataAddOptions): Promise<void>;
-    removeData(displaySetId: DataId): void;
+    addDisplaySet(displaySetId: DisplaySetId, options: DataAddOptions): Promise<void>;
+    getDisplaySets(): Array<{
+        displaySetId: DisplaySetId;
+        options?: unknown;
+    }>;
+    removeData(displaySetId: DisplaySetId): void;
     setDisplaySetPresentation(props: Partial<TDataPresentation>): void;
-    setDisplaySetPresentation(displaySetId: DataId, props: Partial<TDataPresentation>): void;
-    getDisplaySetPresentation(displaySetId: DataId): TDataPresentation | undefined;
+    setDisplaySetPresentation(displaySetId: DisplaySetId, props: Partial<TDataPresentation>): void;
+    getDisplaySetPresentation(displaySetId: DisplaySetId): TDataPresentation | undefined;
     getViewReference(_specifier?: ViewReferenceSpecifier): ViewReference;
     getViewReferenceId(_specifier?: ViewReferenceSpecifier): string;
     setViewReference(_viewReference: ViewReference): void;
@@ -56,20 +60,20 @@ declare abstract class GenericViewport<TViewState extends object, TDataPresentat
     resize(): void;
     resetViewState(_options?: unknown): boolean;
     resizeForRenderingEngine({ keepCamera, }?: RenderingEngineResizeOptions): void;
-    protected addLoadedData(displaySetId: DataId, data: LoadedData, options: DataAddOptions, shouldIgnore?: () => boolean): Promise<boolean>;
+    protected addLoadedData(displaySetId: DisplaySetId, data: LoadedData, options: DataAddOptions, shouldIgnore?: () => boolean): Promise<boolean>;
     protected removeAllData(): void;
-    protected setDataPresentationState(displaySetId: DataId, props: TDataPresentation): void;
-    protected getDataPresentationState(displaySetId: DataId): TDataPresentation | undefined;
-    protected setDefaultDataPresentation(displaySetId: DataId, defaults: TDataPresentation): TDataPresentation;
-    protected mergeDataPresentation(displaySetId: DataId, props: Partial<TDataPresentation>): TDataPresentation;
+    protected setDataPresentationState(displaySetId: DisplaySetId, props: TDataPresentation): void;
+    protected getDataPresentationState(displaySetId: DisplaySetId): TDataPresentation | undefined;
+    protected setDefaultDataPresentation(displaySetId: DisplaySetId, defaults: TDataPresentation): TDataPresentation;
+    protected mergeDataPresentation(displaySetId: DisplaySetId, props: Partial<TDataPresentation>): TDataPresentation;
     protected normalizeViewState(viewState: TViewState): TViewState;
     protected modified(previousCamera?: ICamera): void;
     protected getCameraForEvent(): ICamera;
     protected triggerCameraModifiedEvent(previousCamera: ICamera): void;
     protected triggerCameraResetEvent(): void;
-    protected getBinding(displaySetId: DataId): ViewportDataBinding<TDataPresentation> | undefined;
-    protected getDisplaySetRenderMode(displaySetId: DataId): string | undefined;
-    protected getDisplaySetRole(displaySetId: DataId): BindingRole | undefined;
+    protected getBinding(displaySetId: DisplaySetId): ViewportDataBinding<TDataPresentation> | undefined;
+    protected getDisplaySetRenderMode(displaySetId: DisplaySetId): string | undefined;
+    protected getDisplaySetRole(displaySetId: DisplaySetId): BindingRole | undefined;
     protected getFirstBinding(): ViewportDataBinding<TDataPresentation> | undefined;
     protected getCurrentBinding(): ViewportDataBinding<TDataPresentation> | undefined;
     protected forEachBinding(visitor: (binding: ViewportDataBinding<TDataPresentation>) => void): void;

package/dist/esm/RenderingEngine/GenericViewport/GenericViewport.js

@@ -34,6 +34,12 @@ class GenericViewport {
         const data = await this.dataProvider.load(displaySetId, options);
         await this.addLoadedData(displaySetId, data, options);
     }
+    getDisplaySets() {
+        return Array.from(this.bindings.entries()).map(([displaySetId, binding]) => ({
+            displaySetId,
+            options: { role: binding.role },
+        }));
+    }
     removeData(displaySetId) {
         const binding = this.bindings.get(displaySetId);
         if (!binding) {

package/dist/esm/RenderingEngine/GenericViewport/Planar/DefaultPlanarDataProvider.js

@@ -2,7 +2,7 @@ import { loadAndCacheImage } from '../../../loaders/imageLoader';
 import { createAndCacheVolume } from '../../../loaders/volumeLoader';
 import { ActorRenderMode } from '../../../types';
 import resolveViewportVolumeId from '../../helpers/resolveViewportVolumeId';
-import { getGenericViewportPlanarDataSet } from '../genericViewportDataSetAccess';
+import { getGenericViewportPlanarDisplaySet } from '../genericViewportDisplaySetAccess';
 export class DefaultPlanarDataProvider {
     async load(dataId, options) {
         const dataSet = this.getDataSet(dataId);
@@ -59,7 +59,7 @@ export class DefaultPlanarDataProvider {
         };
     }
     getDataSet(dataId) {
-        const dataSet = getGenericViewportPlanarDataSet(dataId);
+        const dataSet = getGenericViewportPlanarDisplaySet(dataId);
         if (!isPlanarRegisteredDataSet(dataSet)) {
             return;
         }

package/dist/esm/RenderingEngine/GenericViewport/Planar/PlanarLegacyCompatibilityController.js

@@ -4,7 +4,7 @@ import { ActorRenderMode } from '../../../types';
 import triggerEvent from '../../../utilities/triggerEvent';
 import { findMatchingColormap, getMaxOpacity, getThresholdValue, } from '../../../utilities/colormap';
 import { getTransferFunctionNodes } from '../../../utilities/transferFunctionUtils';
-import genericViewportDataSetMetadataProvider from '../../../utilities/genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from '../../../utilities/genericViewportDisplaySetMetadataProvider';
 import { clonePlanarLegacyProperties, mergePlanarLegacyProperties, clonePlanarOrientation, toPlanarDataPresentation, } from './planarLegacyCompatibility';
 import { mapSlabTypeToBlendMode } from './planarVolumeSliceBlendMode';
 export const PLANAR_LEGACY_PER_IMAGE_DEFAULT_PROPERTIES_LIMIT = 2048;
@@ -255,7 +255,7 @@ class PlanarLegacyCompatibilityController {
         return `__planar_v2__:${this.host.getViewportId()}:volume:${volumeId}`;
     }
     registerDataSet(dataId, dataSet) {
-        genericViewportDataSetMetadataProvider.add(dataId, dataSet);
+        genericViewportDisplaySetMetadataProvider.add(dataId, dataSet);
         this.managedDataIds.add(dataId);
     }
     async mountVolumes(volumeInputArray, replaceExisting, suppressEvents) {
@@ -507,7 +507,7 @@ class PlanarLegacyCompatibilityController {
     }
     unregisterDataId(dataId) {
         try {
-            genericViewportDataSetMetadataProvider.remove(dataId);
+            genericViewportDisplaySetMetadataProvider.remove(dataId);
         }
         finally {
             this.properties.delete(dataId);

package/dist/esm/RenderingEngine/GenericViewport/Planar/PlanarViewport.js

@@ -4,13 +4,13 @@ import cache from '../../../cache/cache';
 import { deepClone } from '../../../utilities/deepClone';
 import imageIdToURI from '../../../utilities/imageIdToURI';
 import { getImageDataMetadata } from '../../../utilities/getImageDataMetadata';
-import genericViewportDataSetMetadataProvider from '../../../utilities/genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from '../../../utilities/genericViewportDisplaySetMetadataProvider';
 import triggerEvent from '../../../utilities/triggerEvent';
 import getMinMax from '../../../utilities/getMinMax';
 import renderingEngineCache from '../../renderingEngineCache';
 import { getCameraVectors } from '../../helpers/getCameraVectors';
 import GenericViewport from '../GenericViewport';
-import { getGenericViewportImageDataSet, isGenericViewportImageDataSet, } from '../genericViewportDataSetAccess';
+import { getGenericViewportImageDisplaySet, isGenericViewportImageDisplaySet, } from '../genericViewportDisplaySetAccess';
 import { DefaultPlanarDataProvider } from './DefaultPlanarDataProvider';
 import { createPlanarRenderPathResolver } from './PlanarRenderPathResolver';
 import { normalizePlanarOrientation, selectPlanarRenderPath, } from './planarRenderPathSelector';
@@ -220,10 +220,10 @@ class PlanarViewport extends GenericViewport {
         const dataId = `image-object:${this.id}:${imageIdToURI(image.imageId)}`;
         if (this.renderImageObjectDataId &&
             this.renderImageObjectDataId !== dataId) {
-            genericViewportDataSetMetadataProvider.remove(this.renderImageObjectDataId);
+            genericViewportDisplaySetMetadataProvider.remove(this.renderImageObjectDataId);
         }
         this.renderImageObjectDataId = dataId;
-        genericViewportDataSetMetadataProvider.add(dataId, {
+        genericViewportDisplaySetMetadataProvider.add(dataId, {
             image,
             imageIds: [image.imageId],
             initialImageIdIndex: 0,
@@ -258,7 +258,7 @@ class PlanarViewport extends GenericViewport {
             }
             const reference = this.resolveOverlayReference(stackInput, image);
             const dataId = this.resolveOverlayDataId(stackInput, image, reference);
-            genericViewportDataSetMetadataProvider.add(dataId, {
+            genericViewportDisplaySetMetadataProvider.add(dataId, {
                 image,
                 imageData: stackInput.imageData,
                 imageIds: [stackInput.imageId],
@@ -612,7 +612,7 @@ class PlanarViewport extends GenericViewport {
     onDestroy() {
         this.clearResolvedViewCache();
         if (this.renderImageObjectDataId) {
-            genericViewportDataSetMetadataProvider.remove(this.renderImageObjectDataId);
+            genericViewportDisplaySetMetadataProvider.remove(this.renderImageObjectDataId);
             this.renderImageObjectDataId = undefined;
         }
         this.cpuCanvas?.remove();
@@ -758,7 +758,7 @@ class PlanarViewport extends GenericViewport {
         return this.mountedData.getCurrentBinding();
     }
     getDataSet(dataId) {
-        const dataSet = getGenericViewportImageDataSet(dataId);
+        const dataSet = getGenericViewportImageDisplaySet(dataId);
         if (!isPlanarRegisteredDataSet(dataSet)) {
             return;
         }
@@ -1165,7 +1165,7 @@ function createPlanarImageFromVTKImageData(imageId, imageData) {
     };
 }
 function isPlanarRegisteredDataSet(value) {
-    if (!isGenericViewportImageDataSet(value) || value.imageIds.length === 0) {
+    if (!isGenericViewportImageDisplaySet(value) || value.imageIds.length === 0) {
         return false;
     }
     return ((value.initialImageIdIndex === undefined ||

package/dist/esm/RenderingEngine/GenericViewport/Planar/PlanarViewportLegacyAdapter.js

@@ -3,7 +3,7 @@ import RENDERING_DEFAULTS from '../../../constants/rendering';
 import { ActorRenderMode } from '../../../types';
 import clonePoint3 from '../../../utilities/clonePoint3';
 import hasOwn from '../../../utilities/hasOwn';
-import genericViewportDataSetMetadataProvider from '../../../utilities/genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from '../../../utilities/genericViewportDisplaySetMetadataProvider';
 import { viewportProjection } from '../viewportProjection';
 import PlanarLegacyCompatibilityController from './PlanarLegacyCompatibilityController';
 import PlanarViewport from './PlanarViewport';
@@ -216,7 +216,7 @@ class PlanarViewportLegacyAdapter extends PlanarViewport {
             const bindingDataId = this.findBindingDataIdByActorEntryUID(actorEntryUID);
             if (bindingDataId) {
                 if (this.getDisplaySetRole(bindingDataId) === 'overlay') {
-                    genericViewportDataSetMetadataProvider.remove(bindingDataId);
+                    genericViewportDisplaySetMetadataProvider.remove(bindingDataId);
                 }
                 this.removeData(bindingDataId);
                 didRemoveActor = true;

package/dist/esm/RenderingEngine/GenericViewport/Video/DefaultVideoDataProvider.js

@@ -1,5 +1,5 @@
 import { loadVideoStreamMetadata } from '../../../utilities/VideoUtilities';
-import { getGenericViewportSourceDataId } from '../genericViewportDataSetAccess';
+import { getGenericViewportSourceDataId } from '../genericViewportDisplaySetAccess';
 export class DefaultVideoDataProvider {
     async load(dataId) {
         const sourceDataId = getGenericViewportSourceDataId(dataId);

package/dist/esm/RenderingEngine/GenericViewport/Video/VideoViewport.js

@@ -3,7 +3,7 @@ import { ViewportType } from '../../../enums';
 import { frameNumberToTimeSeconds, timeSecondsToFrameNumber, } from '../../../utilities/VideoUtilities';
 import { generateFrameImageId } from '../../../utilities/splitImageIdsBy4DTags';
 import { DefaultVideoDataProvider } from './DefaultVideoDataProvider';
-import { getGenericViewportSourceDataId } from '../genericViewportDataSetAccess';
+import { getGenericViewportSourceDataId } from '../genericViewportDisplaySetAccess';
 import { createDefaultVideoViewState, normalizeVideoViewState, } from './videoViewportCamera';
 import { createVideoRenderPathResolver } from './VideoRenderPathResolver';
 import VideoResolvedView from './VideoResolvedView';

package/dist/esm/RenderingEngine/GenericViewport/ViewportArchitectureTypes.d.ts

@@ -3,7 +3,7 @@ import type { ReferenceCompatibleOptions, ViewReference, ViewReferenceSpecifier
 import type ViewportType from '../../enums/ViewportType';
 import type ResolvedViewportView from './ResolvedViewportView';
 export type ViewportId = string;
-export type DataId = string;
+export type DisplaySetId = string;
 export type KnownViewportRenderContext = 'planar' | 'video' | 'ecg' | 'wsi' | '3d';
 export type ExtensionViewportRenderContext = string & {};
 export type ViewportRenderContextType = KnownViewportRenderContext | ExtensionViewportRenderContext;
@@ -36,7 +36,7 @@ export interface BasePresentationProps {
     opacity?: number;
 }
 export type LoadedData<TData extends object = object> = {
-    id: DataId;
+    id: DisplaySetId;
     type: LogicalDataType;
 } & TData;
 export type MountedRendering<TRendering extends {
@@ -75,7 +75,7 @@ export interface RenderPathResolver {
     resolve<TContext extends BaseViewportRenderContext>(type: ViewportType, data: LoadedData, options: DataAddOptions): RenderPathDefinition<TContext, BaseViewportRenderContext>;
 }
 export interface DataProvider<TData extends object = object, TOptions = unknown> {
-    load(dataId: DataId, options?: TOptions): Promise<LoadedData<TData>>;
+    load(dataId: DisplaySetId, options?: TOptions): Promise<LoadedData<TData>>;
 }
 export interface ViewportDataBinding<TPresentation = unknown> extends RenderPathAttachment<TPresentation> {
     data: LoadedData;
@@ -84,20 +84,24 @@ export interface ViewportDataBinding<TPresentation = unknown> extends RenderPath
 export interface ViewportController<TViewState = unknown, TDataPresentation = unknown> {
     readonly id: ViewportId;
     readonly type: ViewportType;
-    addDisplaySet(displaySetId: DataId, options: DataAddOptions): Promise<void>;
+    addDisplaySet(displaySetId: DisplaySetId, options: DataAddOptions): Promise<void>;
     setDisplaySets(...entries: Array<{
-        displaySetId: DataId;
+        displaySetId: DisplaySetId;
         options?: unknown;
     }>): Promise<void>;
-    removeData(dataId: DataId): void;
+    getDisplaySets(): Array<{
+        displaySetId: DisplaySetId;
+        options?: unknown;
+    }>;
+    removeData(displaySetId: DisplaySetId): void;
     setViewState(viewState: Partial<TViewState>): void;
     getViewState(): TViewState;
     getResolvedView(): ResolvedViewportView<unknown, ICamera<unknown>> | undefined;
     updateViewState(updater: Partial<TViewState> | ((viewState: TViewState) => Partial<TViewState> | void)): void;
     resetViewState(options?: unknown): boolean;
     setDisplaySetPresentation(props: Partial<TDataPresentation>): void;
-    setDisplaySetPresentation(displaySetId: DataId, props: Partial<TDataPresentation>): void;
-    getDisplaySetPresentation(dataId: DataId): TDataPresentation | undefined;
+    setDisplaySetPresentation(displaySetId: DisplaySetId, props: Partial<TDataPresentation>): void;
+    getDisplaySetPresentation(displaySetId: DisplaySetId): TDataPresentation | undefined;
     setViewReference(viewReference: ViewReference): void;
     getViewReference(specifier?: ViewReferenceSpecifier): ViewReference;
     getViewReferenceId(specifier?: ViewReferenceSpecifier): string;

package/dist/esm/RenderingEngine/GenericViewport/Volume3D/DefaultVolume3DDataProvider.js

@@ -2,7 +2,7 @@ import cache from '../../../cache/cache';
 import { loadAndCacheGeometry } from '../../../loaders/geometryLoader';
 import { createAndCacheVolume } from '../../../loaders/volumeLoader';
 import resolveViewportVolumeId from '../../helpers/resolveViewportVolumeId';
-import { getGenericViewportImageDataSet, isGenericViewportImageDataSet, } from '../genericViewportDataSetAccess';
+import { getGenericViewportImageDisplaySet, isGenericViewportImageDisplaySet, } from '../genericViewportDisplaySetAccess';
 export class DefaultVolume3DDataProvider {
     async load(dataId, options) {
         if (!options) {
@@ -39,7 +39,7 @@ export class DefaultVolume3DDataProvider {
         };
     }
     getDataSet(dataId) {
-        const dataSet = getGenericViewportImageDataSet(dataId);
+        const dataSet = getGenericViewportImageDisplaySet(dataId);
         if (!isVolume3DRegisteredDataSet(dataSet)) {
             return;
         }
@@ -47,7 +47,7 @@ export class DefaultVolume3DDataProvider {
     }
 }
 function isVolume3DRegisteredDataSet(value) {
-    if (!isGenericViewportImageDataSet(value)) {
+    if (!isGenericViewportImageDisplaySet(value)) {
         return false;
     }
     return ((value.geometryId === undefined || typeof value.geometryId === 'string') &&

package/dist/esm/RenderingEngine/GenericViewport/Volume3D/VolumeViewport3DLegacyAdapter.js

@@ -3,7 +3,7 @@ import { VIEWPORT_PRESETS } from '../../../constants';
 import { Events } from '../../../enums';
 import applyPreset from '../../../utilities/applyPreset';
 import triggerEvent from '../../../utilities/triggerEvent';
-import genericViewportDataSetMetadataProvider from '../../../utilities/genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from '../../../utilities/genericViewportDisplaySetMetadataProvider';
 import { viewportProjection } from '../viewportProjection';
 import VolumeViewport3D from './viewport3D';
 class VolumeViewport3DLegacyAdapter extends VolumeViewport3D {
@@ -142,7 +142,7 @@ class VolumeViewport3DLegacyAdapter extends VolumeViewport3D {
                     imageIds: cachedVolume.imageIds,
                     volumeId: volumeInput.volumeId,
                 };
-                genericViewportDataSetMetadataProvider.add(dataId, dataSet);
+                genericViewportDisplaySetMetadataProvider.add(dataId, dataSet);
                 this.managedDataIds.add(dataId);
                 this.volumeDataIds.set(volumeInput.volumeId, dataId);
                 dataIds.push(dataId);
@@ -268,7 +268,7 @@ class VolumeViewport3DLegacyAdapter extends VolumeViewport3D {
         if (!this.managedDataIds.delete(dataId)) {
             return;
         }
-        genericViewportDataSetMetadataProvider.remove(dataId);
+        genericViewportDisplaySetMetadataProvider.remove(dataId);
         this.legacyProperties.delete(dataId);
         this.defaultLegacyProperties.delete(dataId);
         for (const [volumeId, mappedDataId] of this.volumeDataIds.entries()) {
@@ -279,7 +279,7 @@ class VolumeViewport3DLegacyAdapter extends VolumeViewport3D {
     }
     onDestroy() {
         for (const dataId of Array.from(this.managedDataIds)) {
-            genericViewportDataSetMetadataProvider.remove(dataId);
+            genericViewportDisplaySetMetadataProvider.remove(dataId);
         }
         this.managedDataIds.clear();
         this.volumeDataIds.clear();

package/dist/esm/RenderingEngine/GenericViewport/Volume3D/viewport3D.js

@@ -3,7 +3,7 @@ import { ViewportType } from '../../../enums';
 import renderingEngineCache from '../../renderingEngineCache';
 import GenericViewport from '../GenericViewport';
 import { getDimensionGroupReferenceContext, } from '../genericViewportReferenceCompatibility';
-import { getGenericViewportImageDataSet, isGenericViewportImageDataSet, } from '../genericViewportDataSetAccess';
+import { getGenericViewportImageDisplaySet, isGenericViewportImageDisplaySet, } from '../genericViewportDisplaySetAccess';
 import { DefaultVolume3DDataProvider } from './DefaultVolume3DDataProvider';
 import { createVolume3DRenderPathResolver } from './Volume3DRenderPathResolver';
 import Volume3DResolvedView from './Volume3DResolvedView';
@@ -322,7 +322,7 @@ class VolumeViewport3D extends GenericViewport {
         return 'vtkGeometry3d';
     }
     getDataSet(dataId) {
-        const dataSet = getGenericViewportImageDataSet(dataId);
+        const dataSet = getGenericViewportImageDisplaySet(dataId);
         if (!isVolume3DRegisteredDataSet(dataSet)) {
             return;
         }
@@ -388,7 +388,7 @@ function isVolume3DRendering(rendering) {
         rendering.renderMode === 'vtkGeometry3d');
 }
 function isVolume3DRegisteredDataSet(value) {
-    if (!isGenericViewportImageDataSet(value)) {
+    if (!isGenericViewportImageDisplaySet(value)) {
         return false;
     }
     return ((value.geometryId === undefined || typeof value.geometryId === 'string') &&

package/dist/esm/RenderingEngine/GenericViewport/WSI/DefaultWSIDataProvider.js

@@ -1,5 +1,5 @@
 import { addWSIMiniNavigationOverlayCss, loadWSIData, } from '../../../utilities/WSIUtilities';
-import { getGenericViewportWSIDataSet } from '../genericViewportDataSetAccess';
+import { getGenericViewportWSIDisplaySet } from '../genericViewportDisplaySetAccess';
 export class DefaultWSIDataProvider {
     async load(dataId) {
         const dataSet = this.getDataSet(dataId);
@@ -26,7 +26,7 @@ export class DefaultWSIDataProvider {
         };
     }
     getDataSet(dataId) {
-        const registered = getGenericViewportWSIDataSet(dataId);
+        const registered = getGenericViewportWSIDisplaySet(dataId);
         if (!registered) {
             return;
         }

package/dist/esm/RenderingEngine/GenericViewport/WSI/WSIViewportLegacyAdapter.js

@@ -1,6 +1,6 @@
 import { MetadataModules } from '../../../enums';
 import * as metaData from '../../../metaData';
-import genericViewportDataSetMetadataProvider from '../../../utilities/genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from '../../../utilities/genericViewportDisplaySetMetadataProvider';
 import { viewportProjection } from '../viewportProjection';
 import { canvasToIndexForWSI } from './wsiTransformUtils';
 import WSIViewport from './WSIViewport';
@@ -63,7 +63,7 @@ class WSIViewportLegacyAdapter extends WSIViewport {
         if (!webClient) {
             throw new Error(`To use setDataIds on WSI data, you must provide metaData.webClient for ${dataId}.`);
         }
-        genericViewportDataSetMetadataProvider.add(dataId, {
+        genericViewportDisplaySetMetadataProvider.add(dataId, {
             imageIds,
             kind: 'wsi',
             options: {

package/dist/esm/RenderingEngine/GenericViewport/genericViewportDisplaySetAccess.d.ts

@@ -0,0 +1,35 @@
+import type { IImage } from '../../types';
+import type { WSIClientLike } from '../../utilities/WSIUtilities';
+import type { ViewportDataReference } from './ViewportArchitectureTypes';
+export interface GenericViewportImageDisplaySet {
+    imageIds: string[];
+    [key: string]: unknown;
+}
+export interface GenericViewportPlanarDisplaySet extends GenericViewportImageDisplaySet {
+    kind?: 'planar';
+    initialImageIdIndex?: number;
+    volumeId?: string;
+    image?: IImage;
+    reference?: ViewportDataReference;
+}
+export interface GenericViewportSourceAliasDisplaySet {
+    kind: 'video' | 'ecg';
+    sourceDataId: string;
+}
+export interface GenericViewportWSIDisplaySet {
+    kind: 'wsi';
+    imageIds: string[];
+    options: {
+        miniNavigationOverlay?: boolean;
+        webClient: WSIClientLike;
+    };
+}
+export type GenericViewportRegisteredDisplaySet = string | string[] | GenericViewportPlanarDisplaySet | GenericViewportSourceAliasDisplaySet | GenericViewportWSIDisplaySet;
+export declare function getGenericViewportRegisteredDisplaySet(displaySetId: string): GenericViewportRegisteredDisplaySet | undefined;
+export declare function getGenericViewportImageDisplaySet(displaySetId: string): GenericViewportImageDisplaySet | undefined;
+export declare function getGenericViewportPlanarDisplaySet(displaySetId: string): GenericViewportPlanarDisplaySet | undefined;
+export declare function getGenericViewportWSIDisplaySet(displaySetId: string): GenericViewportWSIDisplaySet | undefined;
+export declare function getGenericViewportSourceDataId(displaySetId: string): string;
+export declare function isGenericViewportImageDisplaySet(value: unknown): value is GenericViewportImageDisplaySet;
+export declare function isGenericViewportWSIDisplaySet(value: unknown): value is GenericViewportWSIDisplaySet;
+export declare function isGenericViewportSourceAliasDisplaySet(value: unknown): value is GenericViewportSourceAliasDisplaySet;

package/dist/esm/RenderingEngine/GenericViewport/{genericViewportDataSetAccess.js → genericViewportDisplaySetAccess.js}

@@ -1,27 +1,27 @@
-import genericViewportDataSetMetadataProvider from '../../utilities/genericViewportDataSetMetadataProvider';
-export function getGenericViewportRegisteredData(dataId) {
-    return genericViewportDataSetMetadataProvider.get(genericViewportDataSetMetadataProvider.VIEWPORT_V2_DATA_SET, dataId);
+import genericViewportDisplaySetMetadataProvider from '../../utilities/genericViewportDisplaySetMetadataProvider';
+export function getGenericViewportRegisteredDisplaySet(displaySetId) {
+    return genericViewportDisplaySetMetadataProvider.get(genericViewportDisplaySetMetadataProvider.VIEWPORT_V2_DISPLAY_SET, displaySetId);
 }
-export function getGenericViewportImageDataSet(dataId) {
-    const registered = getGenericViewportRegisteredData(dataId);
+export function getGenericViewportImageDisplaySet(displaySetId) {
+    const registered = getGenericViewportRegisteredDisplaySet(displaySetId);
     if (isStringArray(registered)) {
         return {
             imageIds: registered,
         };
     }
-    if (!isGenericViewportImageDataSet(registered)) {
+    if (!isGenericViewportImageDisplaySet(registered)) {
         return;
     }
     return registered;
 }
-export function getGenericViewportPlanarDataSet(dataId) {
-    const registered = getGenericViewportRegisteredData(dataId);
+export function getGenericViewportPlanarDisplaySet(displaySetId) {
+    const registered = getGenericViewportRegisteredDisplaySet(displaySetId);
     if (isStringArray(registered)) {
         return {
             imageIds: registered,
         };
     }
-    if (!isGenericViewportImageDataSet(registered)) {
+    if (!isGenericViewportImageDisplaySet(registered)) {
         return;
     }
     if ('kind' in registered && registered.kind && registered.kind !== 'planar') {
@@ -29,9 +29,9 @@ export function getGenericViewportPlanarDataSet(dataId) {
     }
     return registered;
 }
-export function getGenericViewportWSIDataSet(dataId) {
-    const registered = getGenericViewportRegisteredData(dataId);
-    if (isGenericViewportWSIDataSet(registered)) {
+export function getGenericViewportWSIDisplaySet(displaySetId) {
+    const registered = getGenericViewportRegisteredDisplaySet(displaySetId);
+    if (isGenericViewportWSIDisplaySet(registered)) {
         return registered;
     }
     if (isRecord(registered) &&
@@ -48,30 +48,30 @@ export function getGenericViewportWSIDataSet(dataId) {
         };
     }
 }
-export function getGenericViewportSourceDataId(dataId) {
-    const registered = getGenericViewportRegisteredData(dataId);
+export function getGenericViewportSourceDataId(displaySetId) {
+    const registered = getGenericViewportRegisteredDisplaySet(displaySetId);
     if (typeof registered === 'string') {
         return registered;
     }
     if (isStringArray(registered) && registered[0]) {
         return registered[0];
     }
-    if (isGenericViewportSourceAliasDataSet(registered)) {
+    if (isGenericViewportSourceAliasDisplaySet(registered)) {
         return registered.sourceDataId;
     }
-    return dataId;
+    return displaySetId;
 }
-export function isGenericViewportImageDataSet(value) {
+export function isGenericViewportImageDisplaySet(value) {
     return isRecord(value) && isStringArray(value.imageIds);
 }
-export function isGenericViewportWSIDataSet(value) {
+export function isGenericViewportWSIDisplaySet(value) {
     return (isRecord(value) &&
         value.kind === 'wsi' &&
         isStringArray(value.imageIds) &&
         isRecord(value.options) &&
         isWSIClientLike(value.options.webClient));
 }
-export function isGenericViewportSourceAliasDataSet(value) {
+export function isGenericViewportSourceAliasDisplaySet(value) {
     return (isRecord(value) &&
         (value.kind === 'video' || value.kind === 'ecg') &&
         typeof value.sourceDataId === 'string');

package/dist/esm/RenderingEngine/GenericViewport/index.d.ts

@@ -4,7 +4,7 @@ export { ViewportProjectionService, viewportProjection, } from './viewportProjec
 export type { BuiltInViewportProjectionByKind, BuiltInViewportProjectionByType, BuiltInViewportProjectionKind, BuiltInViewportProjectionType, ProjectionPresentationForKind, ProjectionPresentationForViewport, ProjectionPresentationForViewportType, ProjectionSnapshotForKind, ProjectionSnapshotForViewport, ProjectionSnapshotForViewportType, ProjectionViewStateForKind, ProjectionViewStateForViewport, ProjectionViewStateForViewportType, } from './viewportProjection';
 export type { ProjectionPosition, ProjectionPresentation, ProjectionRequest, ProjectionScale, ProjectionSnapshot, ProjectionSpaces, ProjectionTransforms, ProjectionWriteOptions, ViewportProjectionAdapter, } from './ViewportProjectionTypes';
 export type { CameraFrame, CameraScale, CameraScaleMode, ViewAnchor, ViewportCameraBase, } from './ViewportCameraTypes';
-export type { BaseViewportRenderContext, BasePresentationProps, DataAddOptions, DataId, DataProvider, ICanvasWorldViewport, IFrameOfReferenceViewport, IPanViewport, IZoomViewport, LoadedData, MountedRendering, RenderPathDefinition, RenderPathAttachment, RenderPathResolver, RenderPath, ViewportDataBinding, ViewportDataReference, ViewportController, ViewportId, ViewportRenderContextType, } from './ViewportArchitectureTypes';
+export type { BaseViewportRenderContext, BasePresentationProps, DataAddOptions, DisplaySetId, DataProvider, ICanvasWorldViewport, IFrameOfReferenceViewport, IPanViewport, IZoomViewport, LoadedData, MountedRendering, RenderPathDefinition, RenderPathAttachment, RenderPathResolver, RenderPath, ViewportDataBinding, ViewportDataReference, ViewportController, ViewportId, ViewportRenderContextType, } from './ViewportArchitectureTypes';
 export { viewportHasCanvasWorldTransform, viewportHasFrameOfReferenceUID, viewportHasPan, viewportHasZoom, } from './ViewportArchitectureTypes';
 export { default as ECGViewport } from './ECG';
 export { createDefaultECGRenderPaths, createECGRenderPathResolver, DefaultECGDataProvider, ecgProjection, } from './ECG';

package/dist/esm/RenderingEngine/StackViewport.d.ts

@@ -142,6 +142,10 @@ declare class StackViewport extends Viewport {
     }): vtkImageDataType;
     private _createVTKImageData;
     setStack(imageIds: string[], currentImageIdIndex?: number): Promise<string>;
+    setDisplaySets(...entries: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>): Promise<void>;
     private _throwIfDestroyed;
     private _checkVTKImageDataMatchesCornerstoneImage;
     private _updateVTKImageDataFromCornerstoneImage;

package/dist/esm/RenderingEngine/StackViewport.js

@@ -8,6 +8,7 @@ import eventTarget from '../eventTarget';
 import * as metaData from '../metaData';
 import { getImageDataMetadata as getImageDataMetadataUtil } from '../utilities/getImageDataMetadata';
 import { coreLog } from '../utilities/logger';
+import { getGenericViewportImageDisplaySet } from './GenericViewport/genericViewportDisplaySetAccess';
 import { actorIsA, isImageActor } from '../utilities/actorCheck';
 import * as colormapUtils from '../utilities/colormap';
 import { getTransferFunctionNodes, setTransferFunctionNodes, } from '../utilities/transferFunctionUtils';
@@ -1304,6 +1305,7 @@ class StackViewport extends Viewport {
     }
     async setStack(imageIds, currentImageIdIndex = 0) {
         this._throwIfDestroyed();
+        this.clearDisplaySets();
         this.imageIds = imageIds;
         if (currentImageIdIndex > imageIds.length) {
             throw new Error('Current image index is greater than the number of images in the stack');
@@ -1341,6 +1343,18 @@ class StackViewport extends Viewport {
         triggerEvent(this.element, Events.VIEWPORT_NEW_IMAGE_SET, eventDetail);
         return imageId;
     }
+    async setDisplaySets(...entries) {
+        await this.mountDisplaySets(entries, async (entry) => {
+            const dataSet = getGenericViewportImageDisplaySet(entry.displaySetId);
+            if (!dataSet?.imageIds?.length) {
+                throw new Error(`[StackViewport] No registered imageIds for display set ${entry.displaySetId}`);
+            }
+            const initialImageIdIndex = typeof dataSet.initialImageIdIndex === 'number'
+                ? dataSet.initialImageIdIndex
+                : 0;
+            await this.setStack(dataSet.imageIds, initialImageIdIndex);
+        });
+    }
     _throwIfDestroyed() {
         if (this.isDisabled) {
             throw new Error('The stack viewport has been destroyed and is no longer usable. Renderings will not be performed. If you ' +

package/dist/esm/RenderingEngine/VideoViewport.d.ts

@@ -1,5 +1,6 @@
 import type { mat4 } from 'gl-matrix';
 import { VideoEnums as VideoViewportEnum } from '../enums';
+import type { DisplaySetId } from './GenericViewport/ViewportArchitectureTypes';
 import type { VideoViewportProperties, Point3, Point2, ICamera, VideoViewportInput, VOIRange, IImage, ViewReferenceSpecifier, ViewReference, ReferenceCompatibleOptions, ImageSetOptions, IStackInput, CPUIImageData, IImageData } from '../types';
 import { Transform } from './helpers/cpuFallback/rendering/transform';
 import Viewport from './Viewport';
@@ -44,6 +45,15 @@ declare class VideoViewport extends Viewport {
         dataId: string;
         options?: Record<string, unknown>;
     }>): Promise<unknown>;
+    setDisplaySets(...entries: Array<{
+        displaySetId: DisplaySetId;
+        options?: {
+            frameNumber?: number;
+            viewReference?: {
+                sliceIndex?: number;
+            };
+        };
+    }>): Promise<void>;
     setVideo(imageId: string, frameNumber?: number): Promise<unknown>;
     private setVideoURL;
     getImageIds(): string[];

package/dist/esm/RenderingEngine/VideoViewport.js

@@ -1,4 +1,5 @@
 import { Events as EVENTS, VideoEnums as VideoViewportEnum } from '../enums';
+import { getGenericViewportSourceDataId } from './GenericViewport/genericViewportDisplaySetAccess';
 import { Transform } from './helpers/cpuFallback/rendering/transform';
 import triggerEvent from '../utilities/triggerEvent';
 import Viewport from './Viewport';
@@ -204,7 +205,19 @@ class VideoViewport extends Viewport {
         }
         return this.setVideo(entries[0].dataId);
     }
+    async setDisplaySets(...entries) {
+        await this.mountDisplaySets(entries, async (entry) => {
+            const sourceDataId = getGenericViewportSourceDataId(entry.displaySetId);
+            const { frameNumber, viewReference } = entry.options ?? {};
+            const initialFrame = frameNumber ??
+                (typeof viewReference?.sliceIndex === 'number'
+                    ? viewReference.sliceIndex + 1
+                    : undefined);
+            await this.setVideo(sourceDataId, initialFrame);
+        });
+    }
     setVideo(imageId, frameNumber) {
+        this.clearDisplaySets();
         this.imageId = Array.isArray(imageId) ? imageId[0] : imageId;
         const stream = loadVideoStreamMetadata(imageId);
         this.modality = stream.modality;

package/dist/esm/RenderingEngine/Viewport.d.ts

@@ -28,6 +28,10 @@ declare class Viewport {
     sWidth: number;
     sHeight: number;
     _actors: Map<string, ActorEntry>;
+    protected _displaySets: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>;
     readonly defaultOptions: ViewportInputOptions;
     options: ViewportInputOptions;
     _suppressCameraModifiedEvents: boolean;
@@ -150,6 +154,19 @@ declare class Viewport {
         dataId: string;
         options?: DataSetOptions;
     }>): void;
+    setDisplaySets(...entries: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>): void | Promise<void>;
+    protected mountDisplaySets<TEntry extends {
+        displaySetId: string;
+        options?: unknown;
+    }>(entries: TEntry[], load: (sourceEntry: TEntry) => void | Promise<void>): Promise<void>;
+    getDisplaySets(): Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>;
+    protected clearDisplaySets(): void;
 }
 export declare function getVolumeCenterIJK(dimensions: number[], direction: ArrayLike<number>, viewPlaneNormal: ArrayLike<number>): number[];
 export default Viewport;

package/dist/esm/RenderingEngine/Viewport.js

@@ -26,6 +26,7 @@ class Viewport {
         this.flipHorizontal = false;
         this.flipVertical = false;
         this.viewportStatus = ViewportStatus.NO_DATA;
+        this._displaySets = [];
         this._suppressCameraModifiedEvents = false;
         this.hasPixelSpacing = true;
         this.getProperties = () => ({});
@@ -1189,6 +1190,23 @@ class Viewport {
     setDataList(_entries) {
         throw new Error('Unsupported operation setDataList');
     }
+    setDisplaySets(...entries) {
+        this._displaySets = entries;
+    }
+    async mountDisplaySets(entries, load) {
+        const [entry] = entries;
+        if (!entry?.displaySetId) {
+            throw new Error(`${this.constructor.name}: setDisplaySets requires a displaySetId`);
+        }
+        await load(entry);
+        this._displaySets = [entry];
+    }
+    getDisplaySets() {
+        return this._displaySets;
+    }
+    clearDisplaySets() {
+        this._displaySets = [];
+    }
 }
 Viewport.CameraViewPresentation = {
     rotation: true,

package/dist/esm/RenderingEngine/WSIViewport.d.ts

@@ -61,6 +61,10 @@ declare class WSIViewport extends Viewport {
         webClient: WSIClientLike;
     }): Promise<void>;
     setWSI(imageIds: string[], client: WSIClientLike): Promise<void>;
+    setDisplaySets(...entries: Array<{
+        displaySetId: string;
+        options?: unknown;
+    }>): Promise<void>;
     postrender: () => void;
     scroll(delta: number): void;
     getRotation: () => number;

package/dist/esm/RenderingEngine/WSIViewport.js

@@ -9,6 +9,7 @@ import { EPSILON } from '../constants';
 import triggerEvent from '../utilities/triggerEvent';
 import eventTarget from '../eventTarget';
 import imageIdToURI from '../utilities/imageIdToURI';
+import { getGenericViewportWSIDisplaySet } from './GenericViewport/genericViewportDisplaySetAccess';
 import { addWSIMiniNavigationOverlayCss, getDicomMicroscopyViewer, loadWSIData, } from '../utilities/WSIUtilities';
 let WSIUtilFunctions = null;
 const EVENT_POSTRENDER = 'postrender';
@@ -341,7 +342,7 @@ class WSIViewport extends Viewport {
             return;
         }
         const { dataId } = entries[0];
-        const dataSet = metaData.get('genericViewportDataSet', dataId);
+        const dataSet = metaData.get('genericViewportDisplaySet', dataId);
         if (dataSet?.imageIds) {
             return this.setDataIds(dataSet.imageIds, {
                 webClient: dataSet.options?.webClient,
@@ -361,6 +362,7 @@ class WSIViewport extends Viewport {
         return this.setWSI(imageIds, webClient);
     }
     async setWSI(imageIds, client) {
+        this.clearDisplaySets();
         this.microscopyElement.style.background = 'black';
         this.microscopyElement.innerText = 'Loading';
         this.imageIds = imageIds;
@@ -397,6 +399,18 @@ class WSIViewport extends Viewport {
             background: 'none',
         });
     }
+    async setDisplaySets(...entries) {
+        await this.mountDisplaySets(entries, async (entry) => {
+            const dataSet = getGenericViewportWSIDisplaySet(entry.displaySetId);
+            if (!dataSet?.imageIds?.length || !dataSet.options?.webClient) {
+                throw new Error(`[WSIViewport] No registered WSI dataset (imageIds + webClient) for display set ${entry.displaySetId}`);
+            }
+            if (dataSet.options.miniNavigationOverlay !== false) {
+                addWSIMiniNavigationOverlayCss();
+            }
+            await WSIViewport.prototype.setWSI.call(this, dataSet.imageIds, dataSet.options.webClient);
+        });
+    }
     scroll(delta) {
         const camera = this.getCamera();
         this.setCamera({

package/dist/esm/utilities/genericViewportDisplaySetMetadataProvider.d.ts

@@ -0,0 +1,8 @@
+declare const genericViewportDisplaySetMetadataProvider: {
+    VIEWPORT_V2_DISPLAY_SET: string;
+    add(displaySetId: string, dataSet: unknown): void;
+    get(type: string, displaySetId: string): unknown;
+    remove(displaySetId: string): void;
+    clear(): void;
+};
+export default genericViewportDisplaySetMetadataProvider;

package/dist/esm/utilities/genericViewportDisplaySetMetadataProvider.js

@@ -0,0 +1,23 @@
+import { addProvider } from '../metaData';
+const VIEWPORT_V2_DISPLAY_SET = 'genericViewportDisplaySet';
+const state = new Map();
+const genericViewportDisplaySetMetadataProvider = {
+    VIEWPORT_V2_DISPLAY_SET,
+    add(displaySetId, dataSet) {
+        state.set(displaySetId, dataSet);
+    },
+    get(type, displaySetId) {
+        if (type !== VIEWPORT_V2_DISPLAY_SET) {
+            return;
+        }
+        return state.get(displaySetId);
+    },
+    remove(displaySetId) {
+        state.delete(displaySetId);
+    },
+    clear() {
+        state.clear();
+    },
+};
+addProvider(genericViewportDisplaySetMetadataProvider.get);
+export default genericViewportDisplaySetMetadataProvider;

package/dist/esm/utilities/index.d.ts

@@ -57,7 +57,7 @@ import { updateVTKImageDataWithCornerstoneImage } from './updateVTKImageDataWith
 import ProgressiveIterator from './ProgressiveIterator';
 import decimate from './decimate';
 import imageRetrieveMetadataProvider from './imageRetrieveMetadataProvider';
-import genericViewportDataSetMetadataProvider from './genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from './genericViewportDisplaySetMetadataProvider';
 import isVideoTransferSyntax from './isVideoTransferSyntax';
 import { getBufferConfiguration } from './getBufferConfiguration';
 import { generateVolumePropsFromImageIds } from './generateVolumePropsFromImageIds';
@@ -111,4 +111,4 @@ import { getNormalizedAspectRatio } from './getNormalizedAspectRatio';
 export { updatePlaneRestriction } from './updatePlaneRestriction';
 declare const getViewportModality: (viewport: IViewport, volumeId?: string) => string;
 export * from './isEqual';
-export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDataSetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, getNormalizedAspectRatio, };
+export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDisplaySetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, getNormalizedAspectRatio, };

package/dist/esm/utilities/index.js

@@ -57,7 +57,7 @@ import { updateVTKImageDataWithCornerstoneImage } from './updateVTKImageDataWith
 import ProgressiveIterator from './ProgressiveIterator';
 import decimate from './decimate';
 import imageRetrieveMetadataProvider from './imageRetrieveMetadataProvider';
-import genericViewportDataSetMetadataProvider from './genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from './genericViewportDisplaySetMetadataProvider';
 import isVideoTransferSyntax from './isVideoTransferSyntax';
 import { getBufferConfiguration } from './getBufferConfiguration';
 import { generateVolumePropsFromImageIds } from './generateVolumePropsFromImageIds';
@@ -112,4 +112,4 @@ import { getNormalizedAspectRatio } from './getNormalizedAspectRatio';
 export { updatePlaneRestriction } from './updatePlaneRestriction';
 const getViewportModality = (viewport, volumeId) => _getViewportModality(viewport, volumeId, cache.getVolume);
 export * from './isEqual';
-export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDataSetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, getNormalizedAspectRatio, };
+export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDisplaySetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, getNormalizedAspectRatio, };

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.0.16";
+export declare const version = "5.1.0";

package/dist/esm/version.js

@@ -1 +1 @@
-export const version = '5.0.16';
+export const version = '5.1.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "5.0.16",
+  "version": "5.1.0",
   "description": "Cornerstone3D Core",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",
@@ -84,18 +84,18 @@
     "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@cornerstonejs/utils": "5.0.16",
+    "@cornerstonejs/utils": "5.1.0",
     "@kitware/vtk.js": "35.5.3",
     "comlink": "4.4.2",
     "gl-matrix": "3.4.3",
     "loglevel": "1.9.2"
   },
   "devDependencies": {
-    "@cornerstonejs/metadata": "5.0.16"
+    "@cornerstonejs/metadata": "5.1.0"
   },
   "peerDependencies": {
-    "@cornerstonejs/metadata": "5.0.16",
-    "@cornerstonejs/utils": "5.0.16"
+    "@cornerstonejs/metadata": "5.1.0",
+    "@cornerstonejs/utils": "5.1.0"
   },
   "contributors": [
     {
@@ -108,5 +108,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "902d3aeef74489bbdd2b1f525823effbf2bbfeb9"
+  "gitHead": "f86b3b590f646412726bfb8bbea8e6724f36cbf1"
 }

package/dist/esm/RenderingEngine/GenericViewport/genericViewportDataSetAccess.d.ts

@@ -1,35 +0,0 @@
-import type { IImage } from '../../types';
-import type { WSIClientLike } from '../../utilities/WSIUtilities';
-import type { ViewportDataReference } from './ViewportArchitectureTypes';
-export interface GenericViewportImageDataSet {
-    imageIds: string[];
-    [key: string]: unknown;
-}
-export interface GenericViewportPlanarDataSet extends GenericViewportImageDataSet {
-    kind?: 'planar';
-    initialImageIdIndex?: number;
-    volumeId?: string;
-    image?: IImage;
-    reference?: ViewportDataReference;
-}
-export interface GenericViewportSourceAliasDataSet {
-    kind: 'video' | 'ecg';
-    sourceDataId: string;
-}
-export interface GenericViewportWSIDataSet {
-    kind: 'wsi';
-    imageIds: string[];
-    options: {
-        miniNavigationOverlay?: boolean;
-        webClient: WSIClientLike;
-    };
-}
-export type GenericViewportRegisteredData = string | string[] | GenericViewportPlanarDataSet | GenericViewportSourceAliasDataSet | GenericViewportWSIDataSet;
-export declare function getGenericViewportRegisteredData(dataId: string): GenericViewportRegisteredData | undefined;
-export declare function getGenericViewportImageDataSet(dataId: string): GenericViewportImageDataSet | undefined;
-export declare function getGenericViewportPlanarDataSet(dataId: string): GenericViewportPlanarDataSet | undefined;
-export declare function getGenericViewportWSIDataSet(dataId: string): GenericViewportWSIDataSet | undefined;
-export declare function getGenericViewportSourceDataId(dataId: string): string;
-export declare function isGenericViewportImageDataSet(value: unknown): value is GenericViewportImageDataSet;
-export declare function isGenericViewportWSIDataSet(value: unknown): value is GenericViewportWSIDataSet;
-export declare function isGenericViewportSourceAliasDataSet(value: unknown): value is GenericViewportSourceAliasDataSet;

package/dist/esm/utilities/genericViewportDataSetMetadataProvider.d.ts

@@ -1,8 +0,0 @@
-declare const genericViewportDataSetMetadataProvider: {
-    VIEWPORT_V2_DATA_SET: string;
-    add(dataId: string, dataSet: unknown): void;
-    get(type: string, dataId: string): unknown;
-    remove(dataId: string): void;
-    clear(): void;
-};
-export default genericViewportDataSetMetadataProvider;

package/dist/esm/utilities/genericViewportDataSetMetadataProvider.js

@@ -1,23 +0,0 @@
-import { addProvider } from '../metaData';
-const VIEWPORT_V2_DATA_SET = 'genericViewportDataSet';
-let state = {};
-const genericViewportDataSetMetadataProvider = {
-    VIEWPORT_V2_DATA_SET,
-    add(dataId, dataSet) {
-        state[dataId] = dataSet;
-    },
-    get(type, dataId) {
-        if (type !== VIEWPORT_V2_DATA_SET) {
-            return;
-        }
-        return state[dataId];
-    },
-    remove(dataId) {
-        delete state[dataId];
-    },
-    clear() {
-        state = {};
-    },
-};
-addProvider(genericViewportDataSetMetadataProvider.get);
-export default genericViewportDataSetMetadataProvider;