Enumeration: Events
Cornerstone Core events
Enumeration Members
CACHE_SIZE_EXCEEDED
CACHE_SIZE_EXCEEDED:
"CACHE_SIZE_EXCEEDED"
Error that is thrown when the ImageCache exceeds its max cache size. This can happen for both volumes and stack images.
Defined in
packages/core/src/enums/Events.ts:14
CAMERA_MODIFIED
CAMERA_MODIFIED:
"CORNERSTONE_CAMERA_MODIFIED"
Triggers on the HTML element when the viewport camera changes.
Make use of EventTypes.CameraModifiedEvent | CameraModified Event Type for typing your event listeners for CAMERA_MODIFIED event, and see what event detail is included in EventTypes.CameraModifiedEventDetail | CameraModified Event Detail
Defined in
packages/core/src/enums/Events.ts:27
CAMERA_RESET
CAMERA_RESET:
"CORNERSTONE_CAMERA_RESET"
Triggers on the HTML element when the viewport camera resets
Make use of EventTypes.CameraResetEvent | CameraReset Event Type for typing your event listeners for CAMERA_RESET event, and see what event detail is included in EventTypes.CameraResetEventDetail | CameraReset Event Detail
Defined in
packages/core/src/enums/Events.ts:34
CLIPPING_PLANES_UPDATED
CLIPPING_PLANES_UPDATED:
"CORNERSTONE_CLIPPING_PLANES_UPDATED"
Triggers when the clipping planes has been updated
Defined in
packages/core/src/enums/Events.ts:237
COLORMAP_MODIFIED
COLORMAP_MODIFIED:
"CORNERSTONE_COLORMAP_MODIFIED"
Triggers on the HTML element when viewport modifies its colormap Make use of EventTypes.ColormapModifiedEvent | ColormapModified Event Type for typing your event listeners for COLORMAP_MODIFIED event, and see what event detail is included in EventTypes.ColormapModifiedEventDetail | ColormapModified Event Detail
Defined in
packages/core/src/enums/Events.ts:255
DISPLAY_AREA_MODIFIED
DISPLAY_AREA_MODIFIED:
"CORNERSTONE_DISPLAY_AREA_MODIFIED"
Triggers on the HTML element when viewport modifies its display area
Make use of EventTypes.DisplayAreaModifiedEvent | DisplayAreaModified Event Type for typing your event listeners for DISPLAY_AREA_MODIFIED event, and see what event detail is included in EventTypes.DisplayAreaModifiedEventDetail | DisplayAreaModified Event Detail
Defined in
packages/core/src/enums/Events.ts:54
DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED
DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED:
"DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED"
Dynamic image volume time point index changed
Defined in
packages/core/src/enums/Events.ts:260
DYNAMIC_VOLUME_TIME_POINT_LOADED
DYNAMIC_VOLUME_TIME_POINT_LOADED:
"DYNAMIC_VOLUME_TIME_POINT_LOADED"
Dynamic image volume time point loaded
Defined in
packages/core/src/enums/Events.ts:265
ELEMENT_DISABLED
ELEMENT_DISABLED:
"CORNERSTONE_ELEMENT_DISABLED"
Triggers on the eventTarget when the element is disabled
Make use of EventTypes.ElementDisabledEvent | ElementDisabled Event Type for typing your event listeners for ELEMENT_DISABLED event, and see what event detail is included in EventTypes.ElementDisabledEventDetail | ElementDisabled Event Detail
Defined in
packages/core/src/enums/Events.ts:61
ELEMENT_ENABLED
ELEMENT_ENABLED:
"CORNERSTONE_ELEMENT_ENABLED"
Triggers on the eventTarget when the element is enabled
Make use of EventTypes.ElementEnabledEvent | ElementEnabled Event Type for typing your event listeners for ELEMENT_ENABLED event, and see what event detail is included in EventTypes.ElementEnabledEventDetail | ElementEnabled Event Detail
Defined in
packages/core/src/enums/Events.ts:68
ERROR_EVENT
ERROR_EVENT:
"CORNERSTONE_ERROR"
ERROR CODES
Defined in
packages/core/src/enums/Events.ts:8
GEOMETRY_CACHE_GEOMETRY_ADDED
GEOMETRY_CACHE_GEOMETRY_ADDED:
"CORNERSTONE_GEOMETRY_CACHE_GEOMETRY_ADDED"
Triggers on the eventTarget when a new geometry is added to the geometry cache
Defined in
packages/core/src/enums/Events.ts:218
GEOMETRY_CACHE_GEOMETRY_REMOVED
GEOMETRY_CACHE_GEOMETRY_REMOVED:
"CORNERSTONE_GEOMETRY_CACHE_GEOMETRY_REMOVED"
Defined in
packages/core/src/enums/Events.ts:221
GEOMETRY_LOADED
GEOMETRY_LOADED:
"GEOMETRY_LOADED"
Triggers on the eventTarget when a geometry has successfully loaded by geometryLoaders
Make use of EventTypes.GeometryLoadedEvent | GeometryLoaded Event Type for typing your event listeners for GEOMETRY_LOADED event, and see what event detail is included in EventTypes.GeometryLoadedEventDetail | GeometryLoaded Event Detail
Defined in
packages/core/src/enums/Events.ts:273
GEOMETRY_LOADED_FAILED
GEOMETRY_LOADED_FAILED:
"GEOMETRY_LOADED_FAILED"
Triggers on the eventTarget when a geometry has failed loading by geometryLoaders
Make use of EventTypes.GeometryLoadedFailedEvent | GeometryLoadedFailed Event Type for typing your event listeners for GEOMETRY_LOADED_FAILED event, and see what event detail is included in EventTypes.GeometryLoadedFailedEventDetail | GeometryLoadedFailed Event Detail
Defined in
packages/core/src/enums/Events.ts:281
IMAGE_CACHE_IMAGE_ADDED
IMAGE_CACHE_IMAGE_ADDED:
"CORNERSTONE_IMAGE_CACHE_IMAGE_ADDED"
Triggers on the eventTarget when an image is added to the image cache
Make use of EventTypes.ImageCacheImageAddedEvent | ImageCacheAdded Event Type for typing your event listeners for IMAGE_CACHE_ADDED event, and see what event detail is included in EventTypes.ImageCacheImageAddedEventDetail | ImageCacheAdded Event Detail
Defined in
packages/core/src/enums/Events.ts:142
IMAGE_CACHE_IMAGE_REMOVED
IMAGE_CACHE_IMAGE_REMOVED:
"CORNERSTONE_IMAGE_CACHE_IMAGE_REMOVED"
Triggers on the eventTarget when an image is removed from the image cache
Make use of EventTypes.ImageCacheImageRemovedEvent | ImageCacheRemoved Event Type for typing your event listeners for IMAGE_CACHE_REMOVED event, and see what event detail is included in EventTypes.ImageCacheImageRemovedEventDetail | ImageCacheRemoved Event Detail
Defined in
packages/core/src/enums/Events.ts:149
IMAGE_LOAD_ERROR
IMAGE_LOAD_ERROR:
"IMAGE_LOAD_ERROR"
Happens if an image (either a single image in stack viewport) or a slice of a volume fails to load by the image/volume loaders.
Defined in
packages/core/src/enums/Events.ts:19
IMAGE_LOAD_FAILED
IMAGE_LOAD_FAILED:
"CORNERSTONE_IMAGE_LOAD_FAILED"
Triggers on the eventTarget when the image has failed loading by imageLoaders
Make use of EventTypes.ImageLoadedFailedEvent | ImageLoadedFailed Event Type for typing your event listeners for IMAGE_LOADED_FAILED event, and see what event detail is included in EventTypes.ImageLoadedFailedEventDetail | ImageLoadedFailed Event Detail
Defined in
packages/core/src/enums/Events.ts:116
IMAGE_LOADED
IMAGE_LOADED:
"CORNERSTONE_IMAGE_LOADED"
Triggers on the eventTarget when the image has successfully loaded by imageLoaders. This event may be fired multiple times for different statuses as the image data gets loaded.
Make use of EventTypes.ImageLoadedEvent | ImageLoaded Event Type for typing your event listeners for IMAGE_LOADED event, and see what event detail is included in EventTypes.ImageLoadedEventDetail | ImageLoaded Event Detail
Defined in
packages/core/src/enums/Events.ts:101
IMAGE_RENDERED
IMAGE_RENDERED:
"CORNERSTONE_IMAGE_RENDERED"
Triggers on the element when the image in the element has been rendered
Make use of EventTypes.ImageRenderedEvent | ImageRendered Event Type for typing your event listeners for IMAGE_RENDERED event, and see what event detail is included in EventTypes.ImageRenderedEventDetail | ImageRendered Event Detail
Defined in
packages/core/src/enums/Events.ts:75
IMAGE_RETRIEVAL_STAGE
IMAGE_RETRIEVAL_STAGE:
"CORNERSTONE_IMAGE_RETRIEVAL_STAGE"
Triggers on the eventTarget when progressive loading stages are completed. That is, the stage is complete for all images included in that stage (which can be zero). If you need individual image load information related to the stage, see the status attribute on the IMAGE_LOADED event - which has the status of the image, but not the actual stage that loaded it.
Defined in
packages/core/src/enums/Events.ts:109
IMAGE_SPACING_CALIBRATED
IMAGE_SPACING_CALIBRATED:
"CORNERSTONE_IMAGE_SPACING_CALIBRATED"
Triggers on the element when the viewport's image has calibrated its pixel spacings
Make use of EventTypes.ImageSpacingCalibratedEvent | ImageSpacingCalibrated Event Type for typing your event listeners for IMAGE_SPACING_CALIBRATED event, and see what event detail is included in EventTypes.ImageSpacingCalibratedEventDetail | ImageSpacingCalibrated Event Detail
Defined in
packages/core/src/enums/Events.ts:194
IMAGE_VOLUME_LOADING_COMPLETED
IMAGE_VOLUME_LOADING_COMPLETED:
"CORNERSTONE_IMAGE_VOLUME_LOADING_COMPLETED"
Triggers on the eventTarget when the image volume loading is completed and all frames are loaded and inserted into a volume.
Make use of EventTypes.ImageVolumeLoadingCompletedEvent | ImageVolumeLoadingCompleted Event Type for typing your event listeners for IMAGE_VOLUME_LOADING_COMPLETED event, and see what event detail is included in EventTypes.ImageVolumeLoadingCompletedEventDetail | ImageVolumeLoadingCompleted Event Detail
Defined in
packages/core/src/enums/Events.ts:93
IMAGE_VOLUME_MODIFIED
IMAGE_VOLUME_MODIFIED:
"CORNERSTONE_IMAGE_VOLUME_MODIFIED"
Triggers on the eventTarget when the image volume data is modified. This happens in the streamingImageLoader when each frame is loaded and inserted into a volume.
Make use of EventTypes.ImageVolumeModifiedEvent | ImageVolumeModified Event Type for typing your event listeners for IMAGE_VOLUME_MODIFIED event, and see what event detail is included in EventTypes.ImageVolumeModifiedEventDetail | ImageVolumeModified Event Detail
Defined in
packages/core/src/enums/Events.ts:84
PRE_STACK_NEW_IMAGE
PRE_STACK_NEW_IMAGE:
"CORNERSTONE_PRE_STACK_NEW_IMAGE"
Triggers on the element when a new image is about to be set on the stackViewport, pre display
Make use of EventTypes.PreStackNewImageEvent | PreStackNewImage Event Type for typing your event listeners for PRE_STACK_NEW_IMAGE event, and see what event detail is included in EventTypes.PreStackNewImageEventDetail | PreStackNewImage Event Detail
Defined in
packages/core/src/enums/Events.ts:187
PRESET_MODIFIED
PRESET_MODIFIED:
"CORNERSTONE_VIEWPORT_RENDERING_PRESET_MODIFIED"
Triggers on the HTML element when viewport modifies its preset (used in volume viewport 3D)
Make use of EventTypes.PresetModifiedEvent | PresetModified Event Type for typing your event listeners for PRESET_MODIFIED event,
Defined in
packages/core/src/enums/Events.ts:47
STACK_NEW_IMAGE
STACK_NEW_IMAGE:
"CORNERSTONE_STACK_NEW_IMAGE"
Triggers on the element when a new image is set on the stackViewport
Make use of EventTypes.StackNewImageEvent | StackNewImage Event Type for typing your event listeners for STACK_NEW_IMAGE event, and see what event detail is included in EventTypes.StackNewImageEventDetail | StackNewImage Event Detail
Defined in
packages/core/src/enums/Events.ts:170
STACK_SCROLL_OUT_OF_BOUNDS
STACK_SCROLL_OUT_OF_BOUNDS:
"STACK_SCROLL_OUT_OF_BOUNDS"
Triggers when the scroll function is called with a delta that is out of bounds in the stack viewport.
Defined in
packages/core/src/enums/Events.ts:213
STACK_VIEWPORT_SCROLL
STACK_VIEWPORT_SCROLL:
"CORNERSTONE_STACK_VIEWPORT_SCROLL"
Triggers on the element when the underlying StackViewport is scrolled. Make use of EventTypes.StackViewportScroll | StackViewportScroll Event Type for typing your event listeners for STACK_VIEWPORT_SCROLL event, and see what event detail is included in EventTypes.StackViewportScrollEventDetail | StackViewportScroll Event Detail
Defined in
packages/core/src/enums/Events.ts:208
VIEWPORT_NEW_IMAGE_SET
VIEWPORT_NEW_IMAGE_SET:
"CORNERSTONE_VIEWPORT_NEW_IMAGE_SET"
Triggers on the event target when a new stack is set on its stack viewport. Make use of EventTypes.StackViewportNewStack | StackViewportNewStack Event Type for typing your event listeners for VIEWPORT_NEW_IMAGE_SET event, and see what event detail is included in EventTypes.StackViewportNewStackEventDetail | StackViewportNewStack Event Detail
Defined in
packages/core/src/enums/Events.ts:201
VOI_MODIFIED
VOI_MODIFIED:
"CORNERSTONE_VOI_MODIFIED"
Triggers on the HTML element when viewport modifies its VOI
Make use of EventTypes.VoiModifiedEvent | VoiModified Event Type for typing your event listeners for VOI_MODIFIED event, and see what event detail is included in EventTypes.VoiModifiedEventDetail | VoiModified Event Detail
Defined in
packages/core/src/enums/Events.ts:41
VOLUME_CACHE_VOLUME_ADDED
VOLUME_CACHE_VOLUME_ADDED:
"CORNERSTONE_VOLUME_CACHE_VOLUME_ADDED"
Triggers on the eventTarget when a volume is added to the volume cache
Make use of EventTypes.VolumeCacheVolumeAddedEvent | VolumeCacheAdded Event Type for typing your event listeners for VOLUME_CACHE_ADDED event, and see what event detail is included in EventTypes.VolumeCacheVolumeAddedEventDetail | VolumeCacheAdded Event Detail
Defined in
packages/core/src/enums/Events.ts:156
VOLUME_CACHE_VOLUME_REMOVED
VOLUME_CACHE_VOLUME_REMOVED:
"CORNERSTONE_VOLUME_CACHE_VOLUME_REMOVED"
Triggers on the eventTarget when a volume is removed from the volume cache
Make use of EventTypes.VolumeCacheVolumeRemovedEvent | VolumeCacheRemoved Event Type for typing your event listeners for VOLUME_CACHE_REMOVED event, and see what event detail is included in EventTypes.VolumeCacheVolumeRemovedEventDetail | VolumeCacheRemoved Event Detail
Defined in
packages/core/src/enums/Events.ts:163
VOLUME_LOADED
VOLUME_LOADED:
"CORNERSTONE_VOLUME_LOADED"
Triggers on the eventTarget when the volume has successfully loaded by volumeLoaders
Make use of EventTypes.VolumeLoadedEvent | VolumeLoaded Event Type for typing your event listeners for VOLUME_LOADED event, and see what event detail is included in EventTypes.VolumeLoadedEventDetail | VolumeLoaded Event Detail
Defined in
packages/core/src/enums/Events.ts:128
VOLUME_LOADED_FAILED
VOLUME_LOADED_FAILED:
"CORNERSTONE_VOLUME_LOADED_FAILED"
Triggers on the eventTarget when the image has failed loading by volumeLoaders
Make use of EventTypes.VolumeLoadedFailedEvent | VolumeLoadedFailed Event Type for typing your event listeners for VOLUME_LOADED_FAILED event, and see what event detail is included in EventTypes.VolumeLoadedFailedEventDetail | VolumeLoadedFailed Event Detail
Defined in
packages/core/src/enums/Events.ts:135
VOLUME_NEW_IMAGE
VOLUME_NEW_IMAGE:
"CORNERSTONE_VOLUME_NEW_IMAGE"
Triggers on the element when a new image is set on the volumeViewport, this can be due to scrolling or other tools that change the camera position or focal point.
Make use of EventTypes.VolumeNewImageEvent | VolumeNewImage Event Type for typing your event listeners for VOLUME_NEW_IMAGE event, and see what event detail is included in EventTypes.VolumeNewImageEventDetail | VolumeNewImage Event Detail
Defined in
packages/core/src/enums/Events.ts:179
VOLUME_VIEWPORT_NEW_VOLUME
VOLUME_VIEWPORT_NEW_VOLUME:
"CORNERSTONE_VOLUME_VIEWPORT_NEW_VOLUME"
Triggers on element when a new voluem is set on the volume viewport
Defined in
packages/core/src/enums/Events.ts:120
VOLUME_VIEWPORT_SCROLL
VOLUME_VIEWPORT_SCROLL:
"VOLUME_VIEWPORT_SCROLL"
Triggers when the scroll function is called on a volume.
Defined in
packages/core/src/enums/Events.ts:232
VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS
VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS:
"VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS"
Triggers when the scroll function is called with a delta that is out of bounds. This is usually for signaling that the user may want a different volume for partially loaded volumes which is meant to optimize memory.
Defined in
packages/core/src/enums/Events.ts:227
WEB_WORKER_PROGRESS
WEB_WORKER_PROGRESS:
"CORNERSTONE_WEB_WORKER_PROGRESS"
Triggers when the webworker has made progress You should use it with a workerType to indicate the type of worker that is making progress Checkout the polySEG convertors in the cornerstone tools to lean how to use it