@cornerstonejs/core 1.6.0 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -44,5 +44,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "cfde297ad3a3ef5f1976751654c847ea63610749"
+  "gitHead": "757fe06aab211f0bd506c40f262264e90290b702"
 }

package/src/enums/Events.ts

@@ -75,6 +75,15 @@ enum Events {
    * and see what event detail is included in {@link EventTypes.ImageVolumeModifiedEventDetail | ImageVolumeModified Event Detail }
    */
   IMAGE_VOLUME_MODIFIED = 'CORNERSTONE_IMAGE_VOLUME_MODIFIED',
+  /**
+   * Triggers on the eventTarget when the image volume loading is completed and all
+   * frames are loaded and inserted into a volume.
+   *
+   * Make use of {@link EventTypes.ImageVolumeLoadingCompletedEvent | ImageVolumeLoadingCompleted Event Type } for typing your
+   * event listeners for IMAGE_VOLUME_LOADING_COMPLETED event, and see what event detail is included
+   * in {@link EventTypes.ImageVolumeLoadingCompletedEventDetail | ImageVolumeLoadingCompleted Event Detail }
+   */
+  IMAGE_VOLUME_LOADING_COMPLETED = 'CORNERSTONE_IMAGE_VOLUME_LOADING_COMPLETED',
   /**
    * Triggers on the eventTarget when the image has successfully loaded by imageLoaders
    *

package/src/types/EventTypes.ts

@@ -111,6 +111,16 @@ type ImageVolumeModifiedEventDetail = {
   FrameOfReferenceUID: string;
 };
 
+/**
+ * IMAGE_VOLUME_LOADING_COMPLETED Event's data
+ */
+type ImageVolumeLoadingCompletedEventDetail = {
+  /** the loaded volume */
+  volumeId: string;
+  /** FrameOfReferenceUID where the volume belongs to */
+  FrameOfReferenceUID: string;
+};
+
 /**
  * IMAGE_LOADED Event's data
  */
@@ -308,6 +318,14 @@ type ImageRenderedEvent = CustomEventType<ElementEnabledEventDetail>;
  */
 type ImageVolumeModifiedEvent = CustomEventType<ImageVolumeModifiedEventDetail>;
 
+/**
+ * IMAGE_VOLUME_LOADING_COMPLETED Event type
+ * This event is fired when a volume is fully loaded, means all the frames
+ * are loaded and cached.
+ */
+type ImageVolumeLoadingCompletedEvent =
+  CustomEventType<ImageVolumeLoadingCompletedEventDetail>;
+
 /**
  * IMAGE_LOADED Event type
  */
@@ -401,6 +419,8 @@ export type {
   ImageRenderedEvent,
   ImageVolumeModifiedEvent,
   ImageVolumeModifiedEventDetail,
+  ImageVolumeLoadingCompletedEvent,
+  ImageVolumeLoadingCompletedEventDetail,
   ImageLoadedEvent,
   ImageLoadedEventDetail,
   ImageLoadedFailedEventDetail,