Enumeration: Events
The events for cornerstoneTools3D Tools. Native Mouse and Keyboard events are
captured, normalized, and re-triggered with a CORNERSTONE_TOOLS
prefix. This
allows us to handle events consistently across different browsers.
Enumeration Members
ANNOTATION_ADDED
ANNOTATION_ADDED:
"CORNERSTONE_TOOLS_ANNOTATION_ADDED"
Triggers on the eventTarget when a new annotation is added to the state.
Make use of EventTypes.AnnotationAddedEventType | Annotation Added Event Type for typing your event listeners for this annotation added event, and see what event detail is included in EventTypes.AnnotationAddedEventDetail | Annotation Added Event Detail.
Defined in
ANNOTATION_COMPLETED
ANNOTATION_COMPLETED:
"CORNERSTONE_TOOLS_ANNOTATION_COMPLETED"
Triggers on the eventTarget when a new annotation is completed its drawing Make use of EventTypes.AnnotationCompletedEventType | Annotation Completed Event Type for typing your event listeners for this annotation completed event, and see what event detail is included in EventTypes.AnnotationCompletedEventDetail | Annotation Completed Event Detail.
Defined in
ANNOTATION_INTERPOLATION_PROCESS_COMPLETED
ANNOTATION_INTERPOLATION_PROCESS_COMPLETED:
"CORNERSTONE_TOOLS_ANNOTATION_INTERPOLATION_PROCESS_COMPLETED"
Triggers on the eventTarget when an annotation interpolation process completed. Make use of EventTypes.AnnotationInterpolationCompletedEventType | Annotation Interpolation process Completed Event Type for typing your event listeners for this annotation interpolation complete event, and see what event detail is included in EventTypes.AnnotationInterpolationCompletedEventDetail | Annotation interpolation process Event Detail.
Defined in
ANNOTATION_LOCK_CHANGE
ANNOTATION_LOCK_CHANGE:
"CORNERSTONE_TOOLS_ANNOTATION_LOCK_CHANGE"
Triggers on the eventTarget when an annotation locked status is changed. Make use of EventTypes.AnnotationLockChangeEventType | Annotation Lock Change Event Type for typing your event listeners for this annotation lock change event, and see what event detail is included in EventTypes.AnnotationLockChangeEventDetail | Annotation Lock Change Event Detail.
Defined in
ANNOTATION_MODIFIED
ANNOTATION_MODIFIED:
"CORNERSTONE_TOOLS_ANNOTATION_MODIFIED"
Triggers on the eventTarget when an annotation is modified (e.g. a handle is modified). Make use of EventTypes.AnnotationModifiedEventType | Annotation Modified Event Type for typing your event listeners for this annotation modified event, and see what event detail is included in EventTypes.AnnotationModifiedEventDetail | Annotation Modified Event Detail.
Defined in
ANNOTATION_REMOVED
ANNOTATION_REMOVED:
"CORNERSTONE_TOOLS_ANNOTATION_REMOVED"
Triggers on the eventTarget when an annotation is removed from the annotations manager. Make use of EventTypes.AnnotationRemovedEventType | Annotation Removed Event Type for typing your event listeners for this annotation removed event, and see what event detail is included in EventTypes.AnnotationRemovedEventDetail | Annotation Removed Event Detail.
Defined in
ANNOTATION_RENDERED
ANNOTATION_RENDERED:
"CORNERSTONE_TOOLS_ANNOTATION_RENDERED"
Triggers on the eventTarget when an annotation is rendered. Make use of EventTypes.AnnotationRenderedEventType | Annotation Rendered Event Type for typing your event listeners for this annotation rendered event, and see what event detail is included in EventTypes.AnnotationRenderedEventDetail | Annotation Rendered Event Detail.
Defined in
ANNOTATION_SELECTION_CHANGE
ANNOTATION_SELECTION_CHANGE:
"CORNERSTONE_TOOLS_ANNOTATION_SELECTION_CHANGE"
Triggers on the eventTarget when an annotation selection status is changed. Make use of EventTypes.AnnotationSelectionChangeEventType | Annotation Selection Change Event Type for typing your event listeners for this annotation selection change event, and see what event detail is included in EventTypes.AnnotationSelectionChangeEventDetail | Annotation Selection Change Event Detail.
Defined in
ANNOTATION_VISIBILITY_CHANGE
ANNOTATION_VISIBILITY_CHANGE:
"CORNERSTONE_TOOLS_ANNOTATION_VISIBILITY_CHANGE"
Triggers on the eventTarget when an annotation visible status is changed. Make use of EventTypes.AnnotationVisibilityChangeEventType | Annotation Visible Change Event Type for typing your event listeners for this annotation Hide change event, and see what event detail is included in EventTypes.AnnotationVisibilityChangeEventDetail | Annotation Visible Change Event Detail.
Defined in
INTERPOLATED_ANNOTATIONS_REMOVED
INTERPOLATED_ANNOTATIONS_REMOVED:
"CORNERSTONE_TOOLS_INTERPOLATED_ANNOTATIONS_REMOVED"
Triggers on the eventTarget when interpolated annotations are removed. Make use of EventTypes.AnnotationInterpolationRemovedEventType | Annotation Interpolation Removed Event Type for typing your event listeners for this interpolated annotation removed event, and see what event detail is included in EventTypes.AnnotationInterpolationRemovedEventDetail | Annotation interpolation removed Event Detail.
Defined in
KEY_DOWN
KEY_DOWN:
"CORNERSTONE_TOOLS_KEY_DOWN"
Triggers on the eventTarget when a key on the keyboard is pressed. Make use of EventTypes.KeyDownEventType | Key Down Event Type for typing your event listeners for this key down event, and see what event detail is included in EventTypes.KeyDownEventDetail | Key Down Event Detail.
Defined in
KEY_UP
KEY_UP:
"CORNERSTONE_TOOLS_KEY_UP"
Triggers on the eventTarget when a key on the keyboard is released. Make use of EventTypes.KeyUpEventType | Key Up Event Type for typing your event listeners for this key up event, and see what event detail is included in EventTypes.KeyUpEventDetail | Key Up Event Detail.
Defined in
MOUSE_CLICK
MOUSE_CLICK:
"CORNERSTONE_TOOLS_MOUSE_CLICK"
Triggers on the eventTarget when a mouse click is detected. It is CornerstoneTools normalized event. Make use of EventTypes.MouseClickEventType | Mouse Click Event Type for typing your event listeners for this mouse click event, and see what event detail is included in EventTypes.MouseClickEventDetail | Mouse Click Event Detail.
Defined in
MOUSE_DOUBLE_CLICK
MOUSE_DOUBLE_CLICK:
"CORNERSTONE_TOOLS_MOUSE_DOUBLE_CLICK"
Triggers on the eventTarget when a mouse double click is detected. It is CornerstoneTools normalized event. Make use of EventTypes.MouseDoubleClickEventType | Mouse Double Click Event Type for typing your event listeners for this mouse double click event, and see what event detail is included in EventTypes.MouseDoubleClickEventDetail | Mouse Double Click Event Detail.
Defined in
MOUSE_DOWN
MOUSE_DOWN:
"CORNERSTONE_TOOLS_MOUSE_DOWN"
Triggers on the eventTarget when the mouse is pressed down, it is CornerstoneTools normalized event. Make use of EventTypes.MouseDownEventType | Mouse Down Event Type for typing your event listeners for this mouse down event, and see what event detail is included in EventTypes.MouseDownEventDetail | Mouse Down Event Detail.
Defined in
MOUSE_DOWN_ACTIVATE
MOUSE_DOWN_ACTIVATE:
"CORNERSTONE_TOOLS_MOUSE_DOWN_ACTIVATE"
Triggers on the eventTarget when a handled MOUSE_DOWN
event does not stopPropagation
. The hook
we use to create new annotation for mouse events.
Make use of EventTypes.MouseDownActivateEventType | Mouse Down Activate Event Type
for typing your event listeners for this mouse down activate event, and see what
event detail is included in EventTypes.MouseDownActivateEventDetail | Mouse Down Activate Event Detail.
Defined in
MOUSE_DRAG
MOUSE_DRAG:
"CORNERSTONE_TOOLS_MOUSE_DRAG"
Triggers on the event target when mouse is dragging an annotation or textBox. Make use of EventTypes.MouseDragEventType | Mouse Drag Event Type for typing your event listeners for this mouse drag event, and see what event detail is included in EventTypes.MouseDragEventDetail | Mouse Drag Event Detail.
Defined in
MOUSE_MOVE
MOUSE_MOVE:
"CORNERSTONE_TOOLS_MOUSE_MOVE"
Triggers on the eventTarget, when the mouse is moved, it is CornerstoneTools normalized event. It can be just a mouse move or when double click is performed and annotation drawing can be performed with just mouse move. Make use of EventTypes.MouseMoveEventType | Mouse Move Event Type for typing your event listeners for this mouse move event, and see what event detail is included in EventTypes.MouseMoveEventDetail | Mouse Move Event Detail.
Defined in
MOUSE_UP
MOUSE_UP:
"CORNERSTONE_TOOLS_MOUSE_UP"
Triggers on the eventTarget when the mouse is released, it is CornerstoneTools normalized event. Make use of EventTypes.MouseUpEventType | Mouse Up Event Type for typing your event listeners for this mouse up event, and see what event detail is included in EventTypes.MouseUpEventDetail | Mouse Up Event Detail.
Defined in
MOUSE_WHEEL
MOUSE_WHEEL:
"CORNERSTONE_TOOLS_MOUSE_WHEEL"
Triggers on the eventTarget when a mouse wheel event is detected. It is CornerstoneTools normalized event. Make use of EventTypes.MouseWheelEventType | Mouse Wheel Event Type for typing your event listeners for this mouse wheel event, and see what event detail is included in EventTypes.MouseWheelEventDetail | Mouse Wheel Event Detail.
Defined in
SEGMENTATION_DATA_MODIFIED
SEGMENTATION_DATA_MODIFIED:
"CORNERSTONE_TOOLS_SEGMENTATION_DATA_MODIFIED"
Triggers on the eventTarget when a Segmentation data is modified (e.g., by brush tool). Make use of EventTypes.SegmentationDataModifiedEventType | Segmentation Data Modified Event Type for typing your event listeners for this segmentation data modified event, and see what event detail is included in EventTypes.SegmentationDataModifiedEventDetail | Segmentation Data Modified Event Detail.
Defined in
SEGMENTATION_MODIFIED
SEGMENTATION_MODIFIED:
"CORNERSTONE_TOOLS_SEGMENTATION_MODIFIED"
Triggers on the eventTarget when a Segmentation is updated in the state manager. Make use of EventTypes.SegmentationModifiedEventType | Segmentation Modified Event Type for typing your event listeners for this segmentation modified event, and see what event detail is included in EventTypes.SegmentationModifiedEventDetail | Segmentation Modified Event Detail.
Defined in
SEGMENTATION_REMOVED
SEGMENTATION_REMOVED:
"CORNERSTONE_TOOLS_SEGMENTATION_REMOVED"
Triggers on the eventTarget when a Segmentation is removed from the state manager. Make use of EventTypes.SegmentationRemovedEventType | Segmentation Removed Event Type for typing your event listeners for this segmentation removed event, and see what event detail is included in EventTypes.SegmentationRemovedEventDetail | Segmentation Removed Event Detail.
Defined in
SEGMENTATION_RENDERED
SEGMENTATION_RENDERED:
"CORNERSTONE_TOOLS_SEGMENTATION_RENDERED"
Triggers on the eventTarget when a Segmentation is rendered by the Segmentation Rendering Engine. Make use of EventTypes.SegmentationRenderedEventType | Segmentation Rendered Event Type for typing your event listeners for this segmentation rendered event, and see what event detail is included in EventTypes.SegmentationRenderedEventDetail | Segmentation Rendered Event Detail.
Defined in
SEGMENTATION_REPRESENTATION_ADDED
SEGMENTATION_REPRESENTATION_ADDED:
"CORNERSTONE_TOOLS_SEGMENTATION_REPRESENTATION_ADDED"
Triggers on the eventTarget when a Segmentation representation of a toolGroup is added in the state manager.
Defined in
SEGMENTATION_REPRESENTATION_MODIFIED
SEGMENTATION_REPRESENTATION_MODIFIED:
"CORNERSTONE_TOOLS_SEGMENTATION_REPRESENTATION_MODIFIED"
Triggers on the eventTarget when a Segmentation representation of a toolGroup is modified in the state manager. Make use of EventTypes.SegmentationRepresentationModifiedEventType | Segmentation Representation Modified Event Type for typing your event listeners for this segmentation representation modified event, and see what event detail is included in EventTypes.SegmentationRepresentationModifiedEventDetail | Segmentation Representation Modified Event Detail.
Defined in
SEGMENTATION_REPRESENTATION_REMOVED
SEGMENTATION_REPRESENTATION_REMOVED:
"CORNERSTONE_TOOLS_SEGMENTATION_REPRESENTATION_REMOVED"
Triggers on the eventTarget when a Segmentation representation of a toolGroup is removed in the state manager. Make use of EventTypes.SegmentationRepresentationRemovedEventType | Segmentation Representation Removed Event Type for typing your event listeners for this segmentation representation removed event, and see what event detail is included in EventTypes.SegmentationRepresentationRemovedEventDetail | Segmentation Representation Removed Event Detail.
Defined in
TOOL_ACTIVATED
TOOL_ACTIVATED:
"CORNERSTONE_TOOLS_TOOL_ACTIVATED"
Triggers on the eventTarget when a new tools is activated.
Make use of EventTypes.ToolActivatedEventType | Tool Activated Event Type for typing your event listeners for this tool activated event, and see what event detail is included in EventTypes.ToolActivatedEventDetail | Tool Activated Event Detail.
Defined in
TOOL_MODE_CHANGED
TOOL_MODE_CHANGED:
"CORNERSTONE_TOOLS_TOOL_MODE_CHANGED"
Triggers on the eventTarget when a mode of a tool is changed (active, passive, enabled and disabled).
Make use of EventTypes.ToolModeChangedEventType | Tool Mode Changed Event Type for typing your event listeners for this tool activated event, and see what event detail is included in EventTypes.ToolModeChangedEventDetail | Tool Mode Changed Event Detail.
Defined in
TOOLGROUP_VIEWPORT_ADDED
TOOLGROUP_VIEWPORT_ADDED:
"CORNERSTONE_TOOLS_TOOLGROUP_VIEWPORT_ADDED"
Defined in
TOOLGROUP_VIEWPORT_REMOVED
TOOLGROUP_VIEWPORT_REMOVED:
"CORNERSTONE_TOOLS_TOOLGROUP_VIEWPORT_REMOVED"
Defined in
TOUCH_DRAG
TOUCH_DRAG:
"CORNERSTONE_TOOLS_TOUCH_DRAG"
Defined in
TOUCH_END
TOUCH_END:
"CORNERSTONE_TOOLS_TOUCH_END"
Defined in
TOUCH_PRESS
TOUCH_PRESS:
"CORNERSTONE_TOOLS_TOUCH_PRESS"
Defined in
TOUCH_START
TOUCH_START:
"CORNERSTONE_TOOLS_TOUCH_START"
Defined in
TOUCH_START_ACTIVATE
TOUCH_START_ACTIVATE:
"CORNERSTONE_TOOLS_TOUCH_START_ACTIVATE"
Defined in
TOUCH_SWIPE
TOUCH_SWIPE:
"CORNERSTONE_TOOLS_SWIPE"
Defined in
TOUCH_TAP
TOUCH_TAP:
"CORNERSTONE_TOOLS_TAP"