Class: VolumeCroppingControlTool

VolumeCroppingControlTool provides interactive reference lines to modify the cropping planes of the VolumeCroppingTool. It renders reference lines across 1 to 3 orthographic viewports and allows users to drag these lines to adjust volume cropping boundaries in real-time.

Remarks

This tool has no standalone functionality and must be used in conjunction with a VolumeCroppingTool that will be receiving volume. Messaging between this tool and the main cropping tool is handled through Cornerstone events that are validated by the series instance UID of the volume. Therefore the tool does not need to be in the same tool group as the volume cropping tool and multiple cropping & control instances can be used on different series in the same display.

Example

// Basic setup
const toolGroup = ToolGroupManager.createToolGroup('myToolGroup');
toolGroup.addTool(VolumeCroppingControlTool.toolName);
toolGroup.addTool(VolumeCroppingTool.toolName);

// Configure with custom colors and settings
toolGroup.setToolConfiguration(VolumeCroppingControlTool.toolName, {
  lineColors: {
    AXIAL: [1.0, 0.0, 0.0],    // Red for axial views
    CORONAL: [0.0, 1.0, 0.0],  // Green for coronal views
    SAGITTAL: [1.0, 1.0, 0.0], // Yellow for sagittal views
  },
  lineWidth: 2.0,
  extendReferenceLines: true,
  viewportIndicators: true
});

// Activate the tool
toolGroup.setToolActive(VolumeCroppingControlTool.toolName);

VolumeCroppingControlTool

Configuration

Events

VOLUMECROPPINGCONTROL_TOOL_CHANGED - Fired when reference lines are dragged or tool state changes VOLUMECROPPING_TOOL_CHANGED - Listens for changes from the main VolumeCroppingTool to synchronize state

Limitations

• Does not function independently without VolumeCroppingTool
• Requires volume data to be loaded before activation
• Limited to orthogonal viewport orientations (axial, coronal, sagittal)l

Extends

• AnnotationTool

Constructors

new VolumeCroppingControlTool()

new VolumeCroppingControlTool(toolProps, defaultToolProps): VolumeCroppingControlTool

Parameters

• toolProps: PublicToolProps = {}

• defaultToolProps: SharedToolProp = ...

Returns

VolumeCroppingControlTool

Overrides

AnnotationTool.constructor

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:203

Properties

_getReferenceLineColor()?

optional _getReferenceLineColor: (viewportId) => string

Optional callback to determine reference line color per viewport

Parameters

• viewportId: string

Returns

string

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:201

---

_getReferenceLineControllable()?

optional _getReferenceLineControllable: (viewportId) => boolean

Optional callback to determine if reference lines are interactive per viewport

Parameters

• viewportId: string

Returns

boolean

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:202

---

_virtualAnnotations

_virtualAnnotations: VolumeCroppingAnnotation[] = []

Store virtual annotations for missing viewport orientations (e.g., CT_CORONAL when only axial and sagittal are present)

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:187

---

configuration

configuration: Record<string, any>

Inherited from

AnnotationTool.configuration

Defined in

tools/src/tools/base/BaseTool.ts:19

---

draggingSphereIndex

draggingSphereIndex: number = null

Index of currently dragged sphere, null when not dragging

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:197

---

editData

editData: object

annotation

annotation: Annotation

handleIndex?

optional handleIndex: number

hasMoved?

optional hasMoved: boolean

movingTextBox?

optional movingTextBox: boolean

newAnnotation?

optional newAnnotation: boolean

viewportIdsToRender?

optional viewportIdsToRender: string[]

Inherited from

AnnotationTool.editData

Defined in

tools/src/tools/base/AnnotationTool.ts:61

---

eventDispatchDetail

protected eventDispatchDetail: object

renderingEngineId

renderingEngineId: string

viewportId

viewportId: string

Inherited from

AnnotationTool.eventDispatchDetail

Defined in

tools/src/tools/base/AnnotationTool.ts:55

---

isDrawing

isDrawing: boolean

Inherited from

AnnotationTool.isDrawing

Defined in

tools/src/tools/base/AnnotationTool.ts:59

---

isHandleOutsideImage

isHandleOutsideImage: boolean

Inherited from

AnnotationTool.isHandleOutsideImage

Defined in

tools/src/tools/base/AnnotationTool.ts:60

---

isSuvScaled()

isSuvScaled: (viewport, targetId, imageId?) => boolean = AnnotationTool.isSuvScaled

Returns true if the viewport is scaled to SUV units

Parameters

• viewport: StackViewport | VolumeViewport

The viewport

• targetId: string

The annotation targetId

• imageId?: string

The annotation imageId

Returns

boolean

Inherited from

AnnotationTool.isSuvScaled

Defined in

tools/src/tools/base/AnnotationTool.ts:420

---

memo

protected memo: Memo

A memo recording the starting state of a tool. This will be updated as changes are made, and reflects the fact that a memo has been created.

Inherited from

AnnotationTool.memo

Defined in

tools/src/tools/base/BaseTool.ts:28

---

mode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Inherited from

AnnotationTool.mode

Defined in

tools/src/tools/base/BaseTool.ts:23

---

seriesInstanceUID?

optional seriesInstanceUID: string

Frame of reference for the tool

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:189

---

sphereStates

sphereStates: object[] = []

Array of sphere state objects for 3D volume manipulation handles

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:190

---

supportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Inherited from

AnnotationTool.supportedInteractionTypes

Defined in

tools/src/tools/base/BaseTool.ts:17

---

toolCenter

toolCenter: Point3

Center point of the cropping volume in world coordinates [x, y, z]

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:198

---

toolCenterMax

toolCenterMax: Point3

Maximum bounds of the cropping volume in world coordinates [xMax, yMax, zMax]

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:200

---

toolCenterMin

toolCenterMin: Point3

Minimum bounds of the cropping volume in world coordinates [xMin, yMin, zMin]

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:199

---

toolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

Inherited from

AnnotationTool.toolGroupId

Defined in

tools/src/tools/base/BaseTool.ts:21

---

defaults

static defaults: object

Has the defaults associated with the base tool.

configuration

configuration: object

configuration.activeStrategy

activeStrategy: any = undefined

configuration.defaultStrategy

defaultStrategy: any = undefined

configuration.strategies

strategies: object = {}

configuration.strategyOptions

strategyOptions: object = {}

Inherited from

AnnotationTool.defaults

Defined in

tools/src/tools/base/BaseTool.ts:33

---

toolName

static toolName: any

Static tool identifier: 'VolumeCroppingControl'

Overrides

AnnotationTool.toolName

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:188

Accessors

toolName

get toolName(): string

Newer method for getting the tool name as a property

Returns

string

Inherited from

AnnotationTool.toolName

Defined in

tools/src/tools/base/BaseTool.ts:82

Methods

_activateModify()

_activateModify(element): void

Parameters

• element: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1735

---

_applyDeltaShiftToSelectedViewportCameras()

_applyDeltaShiftToSelectedViewportCameras(renderingEngine, viewportsAnnotationsToUpdate, delta): void

Parameters

• renderingEngine: any

• viewportsAnnotationsToUpdate: any

• delta: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1847

---

_applyDeltaShiftToViewportCamera()

_applyDeltaShiftToViewportCamera(renderingEngine, annotation, delta): void

Parameters

• renderingEngine: RenderingEngine

• annotation: any

• delta: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1859

---

_computeToolCenter()

_computeToolCenter(viewportsInfo): void

Parameters

• viewportsInfo: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:550

---

_deactivateModify()

_deactivateModify(element): void

Parameters

• element: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1750

---

_dragCallback()

_dragCallback(evt): void

Parameters

• evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1785

---

_endCallback()

_endCallback(evt): void

Parameters

• evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1762

---

_filterViewportWithSameOrientation()

_filterViewportWithSameOrientation(enabledElement, referenceAnnotation, annotations): any

Parameters

• enabledElement: any

• referenceAnnotation: any

• annotations: any

Returns

any

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1691

---

_getAnnotations()

_getAnnotations(enabledElement): Annotation[]

Parameters

• enabledElement: IEnabledElement

Returns

Annotation[]

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1533

---

_getAnnotationsForViewportsWithDifferentCameras()

_getAnnotationsForViewportsWithDifferentCameras(enabledElement, annotations): any

Parameters

• enabledElement: any

• annotations: any

Returns

any

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1655

---

_getOrientationFromNormal()

_getOrientationFromNormal(normal): string

Utility function to map a camera normal to an orientation string. Returns 'AXIAL', 'CORONAL', 'SAGITTAL', or null if not matched.

Parameters

• normal: Point3

Returns

string

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:709

---

_getViewportsInfo()

_getViewportsInfo(): any[]

Returns

any[]

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:404

---

_onNewVolume()

_onNewVolume(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1594

---

_onSphereMoved()

_onSphereMoved(evt): void

Parameters

• evt: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1550

---

_pointNearTool()

_pointNearTool(element, annotation, canvasCoords, proximity): boolean

Parameters

• element: any

• annotation: any

• canvasCoords: any

• proximity: any

Returns

boolean

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1895

---

_subscribeToViewportNewVolumeSet()

_subscribeToViewportNewVolumeSet(viewports): void

Parameters

• viewports: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1640

---

_syncWithVolumeCroppingTool()

_syncWithVolumeCroppingTool(originalClippingPlanes): void

Parameters

• originalClippingPlanes: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:740

---

_unsubscribeToViewportNewVolumeSet()

_unsubscribeToViewportNewVolumeSet(viewportsInfo): void

Parameters

• viewportsInfo: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1625

---

_updateToolCentersFromViewport()

_updateToolCentersFromViewport(viewport): void

Parameters

• viewport: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:291

---

addNewAnnotation()

addNewAnnotation(evt): VolumeCroppingAnnotation

addNewAnnotation is called when the user clicks on the image. It does not store the annotation in the stateManager though.

Parameters

• evt: InteractionEventType

The mouse event

Returns

VolumeCroppingAnnotation

annotation

Overrides

AnnotationTool.addNewAnnotation

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:924

---

applyActiveStrategy()

applyActiveStrategy(enabledElement, operationData): any

Applies the active strategy function to the enabled element with the specified operation data.

Parameters

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

Returns

any

The result of the strategy.

Inherited from

AnnotationTool.applyActiveStrategy

Defined in

tools/src/tools/base/BaseTool.ts:102

---

applyActiveStrategyCallback()

applyActiveStrategyCallback(enabledElement, operationData, callbackType, ...extraArgs): any

Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

Parameters

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

• callbackType: string

the type of the callback

• ...extraArgs: any[]

Returns

any

The result of the strategy.

Inherited from

AnnotationTool.applyActiveStrategyCallback

Defined in

tools/src/tools/base/BaseTool.ts:126

---

cancel()

cancel(): void

cancel Used to cancel the ongoing tool drawing and manipulation

Returns

void

Overrides

AnnotationTool.cancel

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:977

---

computeToolCenter()

computeToolCenter(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:546

---

createAnnotation()

protected createAnnotation(evt): Annotation

Creates an annotation containing the basic data set.

Parameters

• evt: InteractionEventType

Returns

Annotation

Inherited from

AnnotationTool.createAnnotation

Defined in

tools/src/tools/base/AnnotationDisplayTool.ts:134

---

createMemo()

protected createMemo(element, annotation, options?): void

Creates a memo on the given annotation.

Parameters

• element: any

• annotation: any

• options?: any

Returns

void

Inherited from

AnnotationTool.createMemo

Defined in

tools/src/tools/base/AnnotationTool.ts:660

---

doneEditMemo()

doneEditMemo(): void

This clears and edit memo storage to allow for further history functions to be called. Calls the complete function if present, and pushes the memo to the history memo stack.

This should be called when a tool has finished making a change which should be separated from future/other changes in terms of the history. Usually that means on endCallback (mouse up), but some tools also make changes on the initial creation of an object or have alternate flows and the doneEditMemo has to be called on mouse down or other initiation events to ensure that new changes are correctly recorded.

If the tool has no end callback, then the doneEditMemo is called from the pre mouse down callback. See ZoomTool for an example of this usage.

Returns

void

Inherited from

AnnotationTool.doneEditMemo

Defined in

tools/src/tools/base/BaseTool.ts:305

---

filterInteractableAnnotationsForElement()

filterInteractableAnnotationsForElement(element, annotations): any

Given the element and annotations which is an array of annotation, it filters the annotations array to only include the annotation based on the viewportType. If the viewport is StackViewport, it filters based on the current imageId of the viewport, if the viewport is volumeViewport, it only returns those that are within the same slice as the current rendered slice in the volume viewport. imageId as the enabledElement.

Parameters

• element: any

The HTML element

• annotations: any

The annotations to filter (array of annotation)

Returns

any

The filtered annotations

Overrides

AnnotationTool.filterInteractableAnnotationsForElement

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1080

---

getAnnotationStyle()

protected getAnnotationStyle(context): AnnotationStyle

Get the style that will be applied to all annotations such as length, cobb angle, arrow annotate, etc. when rendered on a canvas or svg layer

Parameters

• context

• context.annotation: Annotation

• context.styleSpecifier: StyleSpecifier

Returns

AnnotationStyle

Inherited from

AnnotationTool.getAnnotationStyle

Defined in

tools/src/tools/base/AnnotationTool.ts:426

---

getHandleNearImagePoint()

getHandleNearImagePoint(element, annotation, canvasCoords, proximity): ToolHandle

It checks if the mouse click is near TextBoxHandle or AnnotationHandle itself, and return either it. It prioritize TextBoxHandle over AnnotationHandle. If the mouse click is not near any of the handles, it does not return anything.

Parameters

• element: HTMLDivElement

The element that the tool is attached to.

• annotation: Annotation

The annotation object associated with the annotation

• canvasCoords: Point2

The coordinates of the mouse click on canvas

• proximity: number

The distance from the mouse cursor to the point that is considered "near".

Returns

ToolHandle

The handle that is closest to the cursor, or null if the cursor is not near any of the handles.

Inherited from

AnnotationTool.getHandleNearImagePoint

Defined in

tools/src/tools/base/AnnotationTool.ts:293

---

getLinkedTextBoxStyle()

getLinkedTextBoxStyle(specifications, annotation?): Record<string, unknown>

It returns the style for the text box

Parameters

• specifications: StyleSpecifier

• annotation?: Annotation

The annotation for the tool that is currently active.

Returns

Record<string, unknown>

An object of the style settings for the text box.

Inherited from

AnnotationTool.getLinkedTextBoxStyle

Defined in

tools/src/tools/base/AnnotationTool.ts:359

---

getReferencedImageId()

protected getReferencedImageId(viewport, worldPos, viewPlaneNormal, viewUp?): string

Parameters

• viewport: Viewport

• worldPos: Point3

• viewPlaneNormal: Point3

• viewUp?: Point3

Returns

string

Inherited from

AnnotationTool.getReferencedImageId

Defined in

tools/src/tools/base/AnnotationDisplayTool.ts:184

---

getStyle()

getStyle(property, specifications, annotation?): unknown

It takes the property (color, lineDash, etc.) and based on the state of the annotation (selected, highlighted etc.) it returns the appropriate value based on the central toolStyle settings for each level of specification.

Parameters

• property: string

The name of the style property to get.

• specifications: StyleSpecifier

• annotation?: Annotation

The annotation for the tool that is currently active.

Returns

unknown

The value of the property.

Inherited from

AnnotationTool.getStyle

Defined in

tools/src/tools/base/AnnotationDisplayTool.ts:221

---

getTargetId()

protected getTargetId(viewport): string

Get the target Id for the viewport which will be used to store the cached statistics scoped to that target in the annotations. For StackViewport, targetId is the viewportId, but for the volume viewport, the targetId will be grabbed from the volumeId if particularly specified in the tool configuration, or if not, the first actorUID in the viewport.

Parameters

• viewport: Viewport

viewport to get the targetId for

Returns

string

targetId

Inherited from

AnnotationTool.getTargetId

Defined in

tools/src/tools/base/BaseTool.ts:238

---

getTargetImageData()

protected getTargetImageData(targetId): IImageData | CPUIImageData

Get the image that is displayed for the targetId in the cachedStats which can be

• imageId:<imageId>
• volumeId:<volumeId>
• videoId:<basePathForVideo>/frames/<frameSpecifier>

Parameters

• targetId: string

annotation targetId stored in the cached stats

Returns

IImageData | CPUIImageData

The image data for the target.

Inherited from

AnnotationTool.getTargetImageData

Defined in

tools/src/tools/base/BaseTool.ts:181

---

getToolName()

getToolName(): string

Returns the name of the tool

Returns

string

The name of the tool.

Inherited from

AnnotationTool.getToolName

Defined in

tools/src/tools/base/BaseTool.ts:90

---

handleSelectedCallback()

handleSelectedCallback(evt, annotation, handle, interactionType): void

handleSelectedCallback Custom callback for when a handle is selected.

Parameters

• evt: InteractionEventType

The normalized mouse event

• annotation: Annotation

The annotation selected.

• handle: ToolHandle

The selected handle (either Types.Point3 in space for annotations, or TextBoxHandle object for text boxes).

• interactionType: InteractionTypes

The interaction type the handle was selected with.

Returns

void

Overrides

AnnotationTool.handleSelectedCallback

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1020

---

initializeViewport()

initializeViewport(viewportInfo): object

Gets the camera from the viewport, and adds annotation for the viewport to the annotationManager. If any annotation is found in the annotationManager, it overwrites it.

Parameters

• viewportInfo: IViewportId

The viewportInfo for the viewport

Returns

object

viewPlaneNormal and center of viewport canvas in world space

normal

normal: Point3

point

point: Point3

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:333

---

isPointNearTool()

isPointNearTool(element, annotation, canvasCoords, proximity): boolean

It returns if the canvas point is near the provided volume cropping annotation in the provided element or not. A proximity is passed to the function to determine the proximity of the point to the annotation in number of pixels.

Parameters

• element: HTMLDivElement

HTML Element

• annotation: VolumeCroppingAnnotation

Annotation

• canvasCoords: Point2

Canvas coordinates

• proximity: number

Proximity to tool to consider

Returns

boolean

Boolean, whether the canvas point is near tool

Overrides

AnnotationTool.isPointNearTool

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:992

---

mouseMoveCallback()

mouseMoveCallback(evt, filteredToolAnnotations): boolean

Event handler for Cornerstone MOUSE_MOVE event.

Parameters

• evt: MouseMoveEventType

The normalized mouse event

• filteredToolAnnotations: Annotations

The annotations to check for hover interactions

Returns

boolean

True if the annotation needs to be re-drawn by the annotationRenderingEngine.

Overrides

AnnotationTool.mouseMoveCallback

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1035

---

onImageSpacingCalibrated()

onImageSpacingCalibrated(evt): void

On Image Calibration, take all the annotation from the AnnotationState manager, and invalidate them to force them to be re-rendered and their stats to be recalculated. Then use the old and new imageData (non-calibrated and calibrated) to calculate the new position for the annotations in the space of the new imageData.

Parameters

• evt: ImageSpacingCalibratedEvent

The calibration event

Returns

void

Inherited from

AnnotationTool.onImageSpacingCalibrated

Defined in

tools/src/tools/base/AnnotationDisplayTool.ts:88

---

onResetCamera()

onResetCamera(evt): void

Parameters

• evt: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1031

---

onSetToolActive()

onSetToolActive(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:415

---

onSetToolDisabled()

onSetToolDisabled(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:478

---

onSetToolEnabled()

onSetToolEnabled(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:469

---

onSetToolInactive()

onSetToolInactive(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:409

---

redo()

redo(): void

Redo an action (undo the undo)

Returns

void

Inherited from

AnnotationTool.redo

Defined in

tools/src/tools/base/BaseTool.ts:261

---

renderAnnotation()

renderAnnotation(enabledElement, svgDrawingHelper): boolean

renders the volume cropping lines and handles in the requestAnimationFrame callback

Parameters

• enabledElement: IEnabledElement

The Cornerstone's enabledElement.

• svgDrawingHelper: SVGDrawingHelper

The svgDrawingHelper providing the context for drawing.

Returns

boolean

Overrides

AnnotationTool.renderAnnotation

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1120

---

resetCroppingSpheres()

resetCroppingSpheres(): void

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:509

---

setActiveStrategy()

setActiveStrategy(strategyName): void

Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.

Parameters

• strategyName: string

name of the strategy to be set as active

Returns

void

Inherited from

AnnotationTool.setActiveStrategy

Defined in

tools/src/tools/base/BaseTool.ts:167

---

setConfiguration()

setConfiguration(newConfiguration): void

merges the new configuration with the tool configuration

Parameters

• newConfiguration: Record<string, any>

Returns

void

Inherited from

AnnotationTool.setConfiguration

Defined in

tools/src/tools/base/BaseTool.ts:153

---

setToolCenter()

setToolCenter(toolCenter, handleType): void

Parameters

• toolCenter: Point3

• handleType: any

Returns

void

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:901

---

toolSelectedCallback()

toolSelectedCallback(evt, annotation, interactionType): void

Custom callback for when an annotation is selected

Parameters

• evt: InteractionEventType

The normalized mouse event

• annotation: Annotation

The Annotation to check.

• interactionType: InteractionTypes

The interaction type used to select the tool.

Returns

void

Overrides

AnnotationTool.toolSelectedCallback

Defined in

tools/src/tools/VolumeCroppingControlTool.ts:1005

---

undo()

undo(): void

Undoes an action

Returns

void

Inherited from

AnnotationTool.undo

Defined in

tools/src/tools/base/BaseTool.ts:251

---

createAndAddAnnotation()

static createAndAddAnnotation(viewport, ...annotationBaseData): void

Creates and adds an annotation of the given type, firing the annotation modified event on the new annotation. This implicitly uses the static class when you call it on the correct base class. For example, you can call the KeyImageTool.createAnnotation method on KeyImageTool.toolName by calling KeyImageTool.createAndAddAnnotation

Parameters

• viewport: any

• ...annotationBaseData: any[]

Returns

void

Inherited from

AnnotationTool.createAndAddAnnotation

Defined in

tools/src/tools/base/AnnotationTool.ts:128

---

createAnnotation()

static createAnnotation(...annotationBaseData): Annotation

Creates a base annotation object, adding in any annotation base data provided

Parameters

• ...annotationBaseData: any[]

Returns

Annotation

Inherited from

AnnotationTool.createAnnotation

Defined in

tools/src/tools/base/AnnotationTool.ts:73

---

createAnnotationForViewport()

static createAnnotationForViewport<T>(viewport, ...annotationBaseData): T

Creates a new annotation for the given viewport. This just adds the viewport reference data to the metadata, and otherwise returns the static class createAnnotation data.

Type Parameters

• T extends Annotation

Parameters

• viewport: any

• ...annotationBaseData: any[]

Returns

T

Inherited from

AnnotationTool.createAnnotationForViewport

Defined in

tools/src/tools/base/AnnotationTool.ts:110

---

createAnnotationMemo()

static createAnnotationMemo(element, annotation, options?): object

Creates an annotation memo storing the current data state on the given annotation object. This will store/recover handles data, text box and contour data, and if the options are set for deletion, will apply that correctly.

Parameters

• element: any

that the annotation is shown on.

• annotation: Annotation

to store a memo for the current state.

• options?

whether the annotation is being created (newAnnotation) or is in the process of being deleted (deleting)

• Note the naming on deleting is to indicate the deletion is in progress, as the createAnnotationMemo needs to be called BEFORE the annotation is actually deleted.
• deleting with a value of false is the same as newAnnotation=true, as it is simply the opposite direction. Use undefined for both newAnnotation and deleting for non-create/delete operations.

• options.deleting?: boolean

• options.newAnnotation?: boolean

Returns

object

Memo containing the annotation data.

id

id: string = annotationUID

operationType

operationType: string = 'annotation'

restoreMemo()

restoreMemo: () => void

Returns

void

Inherited from

AnnotationTool.createAnnotationMemo

Defined in

tools/src/tools/base/AnnotationTool.ts:567

---

createAnnotationState()

protected static createAnnotationState(annotation, deleting?): object

Creates an annotation state copy to allow storing the current state of an annotation. This class has knowledge about the contour and spline implementations in order to copy the contour object efficiently, and to allow copying the spline object (which has member variables etc).

Parameters

• annotation: Annotation

the annotation to create a clone of

• deleting?: boolean

a flag to indicate that this object is about to be deleted (deleting true), or was just created (deleting false), or neither (deleting undefined).

Returns

object

state information for the given annotation.

annotationUID

annotationUID: string

data

data: AnnotationData

deleting

deleting: boolean

Inherited from

AnnotationTool.createAnnotationState

Defined in

tools/src/tools/base/AnnotationTool.ts:514

---

createZoomPanMemo()

static createZoomPanMemo(viewport): object

Creates a zoom/pan memo that remembers the original zoom/pan position for the given viewport.

Parameters

• viewport: any

Returns

object

restoreMemo()

restoreMemo: () => void

Returns

void

Inherited from

AnnotationTool.createZoomPanMemo

Defined in

tools/src/tools/base/BaseTool.ts:269

---

endGroupRecording()

static endGroupRecording(): void

Ends a group recording of history memo

Returns

void

Inherited from

AnnotationTool.endGroupRecording

Defined in

tools/src/tools/base/BaseTool.ts:318

---

hydrateBase()

protected static hydrateBase<T>(ToolClass, enabledElement, points, options): object

Type Parameters

• T extends AnnotationTool

Parameters

• ToolClass

• enabledElement: IEnabledElement

• points: Point3[]

• options = {}

• options.annotationUID?: string

• options.referencedImageId?: string

• options.toolInstance?: T

• options.viewplaneNormal?: Point3

• options.viewUp?: Point3

Returns

object

FrameOfReferenceUID

FrameOfReferenceUID: string

instance

instance: T

referencedImageId

referencedImageId: any

viewPlaneNormal

viewPlaneNormal: Point3 = finalViewPlaneNormal

viewport

viewport: StackViewport | VolumeViewport

viewUp

viewUp: Point3 = finalViewUp

Inherited from

AnnotationTool.hydrateBase

Defined in

tools/src/tools/base/AnnotationTool.ts:668

---

isSuvScaled()

static isSuvScaled(viewport, targetId, imageId?): boolean

Returns true if the viewport is scaled to SUV units

Parameters

• viewport: StackViewport | VolumeViewport

The viewport

• targetId: string

The annotation targetId

• imageId?: string

The annotation imageId

Returns

boolean

Inherited from

AnnotationTool.isSuvScaled

Defined in

tools/src/tools/base/AnnotationTool.ts:405

---

mergeDefaultProps()

static mergeDefaultProps(defaultProps, additionalProps?): any

Does a deep merge of property options. Allows extending the default values for a child class.

Parameters

• defaultProps = {}

this is a base set of defaults to merge into

• additionalProps?: any

the additional properties to merge into the default props

Returns

any

defaultProps if additional props not defined, or a merge into a new object containing additionalProps adding onto and overriding defaultProps.

Inherited from

AnnotationTool.mergeDefaultProps

Defined in

tools/src/tools/base/BaseTool.ts:72

---

startGroupRecording()

static startGroupRecording(): void

Starts a group recording of history memo, so that with a single undo you can undo multiple actions that are related to each other

Returns

void

Inherited from

AnnotationTool.startGroupRecording

Defined in

tools/src/tools/base/BaseTool.ts:313