Class: ArrowAnnotateTool
Abstract class for tools which create and display annotations on the cornerstone3D canvas. In addition, it provides a base class for segmentation tools that require drawing an annotation before running the segmentation strategy for instance threshold segmentation based on an area and a threshold. Annotation tools make use of drawing utilities to draw SVG elements on the viewport.
To create a new annotation tool, derive from this class and implement the abstract methods.
Extends
Constructors
new ArrowAnnotateTool()
new ArrowAnnotateTool(
toolProps,defaultToolProps):ArrowAnnotateTool
Parameters
• toolProps: PublicToolProps = {}
• defaultToolProps: SharedToolProp = ...
Returns
Overrides
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:63
Properties
_throttledCalculateCachedStats
_throttledCalculateCachedStats:
Function
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:51
configuration
configuration:
Record<string,any>
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:19
editData
editData:
object
annotation
annotation:
Annotation
handleIndex?
optionalhandleIndex:number
hasMoved?
optionalhasMoved:boolean
movingTextBox?
optionalmovingTextBox:boolean
newAnnotation?
optionalnewAnnotation:boolean
viewportIdsToRender
viewportIdsToRender:
string[]
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:52
isDrawing
isDrawing:
boolean
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:60
isHandleOutsideImage
isHandleOutsideImage:
boolean
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:61
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
Defined in
tools/src/tools/base/AnnotationTool.ts:401
memo
protectedmemo: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
Defined in
tools/src/tools/base/BaseTool.ts:28
mode
mode:
ToolModes
Tool Mode - Active/Passive/Enabled/Disabled/
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:23
supportedInteractionTypes
supportedInteractionTypes:
InteractionTypes[]
Supported Interaction Types - currently only Mouse
Inherited from
AnnotationTool.supportedInteractionTypes
Defined in
tools/src/tools/base/BaseTool.ts:17
toolGroupId
toolGroupId:
string
ToolGroup ID the tool instance belongs to
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:21
defaults
staticdefaults: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
Defined in
tools/src/tools/base/BaseTool.ts:33
toolName
statictoolName:any
Overrides
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:49
Accessors
toolName
gettoolName():string
Newer method for getting the tool name as a property
Returns
string
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:82
Methods
_activateDraw()
_activateDraw(
element):void
Parameters
• element: HTMLDivElement
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:610
_activateModify()
_activateModify(
element):void
Parameters
• element: HTMLDivElement
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:550
_deactivateDraw()
_deactivateDraw(
element):void
Parameters
• element: HTMLDivElement
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:644
_deactivateModify()
_deactivateModify(
element):void
Parameters
• element: HTMLDivElement
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:580
_doneChangingTextCallback()
_doneChangingTextCallback(
element,annotation,updatedText):void
Parameters
• element: any
• annotation: any
• updatedText: any
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:510
_dragCallback()
_dragCallback(
evt):void
Parameters
• evt: InteractionEventType
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:399
_endCallback()
_endCallback(
evt):void
Parameters
• evt: InteractionEventType
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:346
_isInsideVolume()
_isInsideVolume(
index1,index2,dimensions):boolean
Parameters
• index1: any
• index2: any
• dimensions: any
Returns
boolean
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:852
addNewAnnotation()
addNewAnnotation(
evt):ArrowAnnotation
Based on the current position of the mouse and the current imageId to create a Length Annotation and stores it in the annotationManager
Parameters
• evt: InteractionEventType
EventTypes.NormalizedMouseEventType
Returns
The annotation object.
Overrides
AnnotationTool.addNewAnnotation
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:141
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(
element):string
cancel Used to cancel the ongoing tool drawing and manipulation
Parameters
• element: HTMLDivElement
Returns
string
Overrides
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:525
createAnnotation()
protectedcreateAnnotation(evt):Annotation
Creates an annotation containing the basic data set.
Parameters
• evt: InteractionEventType
Returns
Inherited from
AnnotationTool.createAnnotation
Defined in
tools/src/tools/base/AnnotationDisplayTool.ts:134
createMemo()
protectedcreateMemo(element,annotation,options?):void
Creates a memo on the given annotation.
Parameters
• element: any
• annotation: any
• options?: any
Returns
void
Inherited from
Defined in
tools/src/tools/base/AnnotationTool.ts:635
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
Defined in
tools/src/tools/base/BaseTool.ts:305
doubleClickCallback()
doubleClickCallback(
evt):void
Parameters
• evt: TouchTapEventType
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:464
filterInteractableAnnotationsForElement()
filterInteractableAnnotationsForElement(
element,annotations):Annotations
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: HTMLDivElement
The HTML element
• annotations: Annotations
The annotations to filter (array of annotation)
Returns
The filtered annotations
Inherited from
AnnotationTool.filterInteractableAnnotationsForElement
Defined in
tools/src/tools/base/AnnotationDisplayTool.ts:63
getAnnotationStyle()
protectedgetAnnotationStyle(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
Inherited from
AnnotationTool.getAnnotationStyle
Defined in
tools/src/tools/base/AnnotationTool.ts:407
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
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:274
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:340
getReferencedImageId()
protectedgetReferencedImageId(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
Defined in
tools/src/tools/base/AnnotationDisplayTool.ts:221
getTargetId()
protectedgetTargetId(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
Defined in
tools/src/tools/base/BaseTool.ts:238
getTargetImageData()
protectedgetTargetImageData(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
Defined in
tools/src/tools/base/BaseTool.ts:90
handleSelectedCallback()
handleSelectedCallback(
evt,annotation,handle):void
handleSelectedCallback Custom callback for when a handle is selected.
Parameters
• evt: InteractionEventType
The normalized mouse event
• annotation: ArrowAnnotation
The annotation selected.
• handle: ToolHandle
The selected handle (either Types.Point3 in space for annotations, or TextBoxHandle object for text boxes).
Returns
void
Overrides
AnnotationTool.handleSelectedCallback
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:302
isPointNearTool()
isPointNearTool(
element,annotation,canvasCoords,proximity):boolean
It returns if the canvas point is near the provided length 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: ArrowAnnotation
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/annotation/ArrowAnnotateTool.ts:233
mouseMoveCallback()
mouseMoveCallback(
evt,filteredAnnotations?):boolean
Event handler for Cornerstone MOUSE_MOVE event.
Parameters
• evt: MouseMoveEventType
The normalized mouse event
• filteredAnnotations?: Annotations
The annotations to check for hover interactions
Returns
boolean
True if the annotation needs to be re-drawn by the annotationRenderingEngine.
Inherited from
AnnotationTool.mouseMoveCallback
Defined in
tools/src/tools/base/AnnotationTool.ts:209
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
redo()
redo():
void
Redo an action (undo the undo)
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:261
renderAnnotation()
renderAnnotation(
enabledElement,svgDrawingHelper):boolean
it is used to draw the length annotation in each request animation frame. It calculates the updated cached statistics if data is invalidated and cache it.
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/annotation/ArrowAnnotateTool.ts:686
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
toolSelectedCallback()
toolSelectedCallback(
evt,annotation):void
Custom callback for when an annotation is selected
Parameters
• evt: InteractionEventType
The normalized mouse event
• annotation: ArrowAnnotation
The Annotation to check.
Returns
void
Overrides
AnnotationTool.toolSelectedCallback
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:270
touchTapCallback()
touchTapCallback(
evt):void
Parameters
• evt: TouchTapEventType
Returns
void
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:458
undo()
undo():
void
Undoes an action
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:251
createAndAddAnnotation()
staticcreateAndAddAnnotation(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:109
createAnnotation()
staticcreateAnnotation(...annotationBaseData):Annotation
Creates a base annotation object, adding in any annotation base data provided
Parameters
• ...annotationBaseData: any[]
Returns
Inherited from
AnnotationTool.createAnnotation
Defined in
tools/src/tools/base/AnnotationTool.ts:57
createAnnotationForViewport()
staticcreateAnnotationForViewport(viewport, ...annotationBaseData):Annotation
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.
Parameters
• viewport: any
• ...annotationBaseData: any[]
Returns
Inherited from
AnnotationTool.createAnnotationForViewport
Defined in
tools/src/tools/base/AnnotationTool.ts:94
createAnnotationMemo()
staticcreateAnnotationMemo(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.
restoreMemo()
restoreMemo: () =>
void
Returns
void
Inherited from
AnnotationTool.createAnnotationMemo
Defined in
tools/src/tools/base/AnnotationTool.ts:544
createAnnotationState()
protectedstaticcreateAnnotationState(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:
object
Index Signature
[key: string]: unknown
data.cachedStats?
optionalcachedStats:Record<string,unknown>
Cached Annotation statistics which is specific to the tool
data.handles?
optionalhandles:object
Annotation handles that are grabbable for manipulation
Index Signature
[key: string]: unknown
data.handles.activeHandleIndex?
optionalactiveHandleIndex:number
index of the active handle being manipulated
data.handles.points?
optionalpoints:Point3[]
world location of the handles in the space
data.handles.textBox?
optionaltextBox:object
annotation text box information
data.handles.textBox.hasMoved?
optionalhasMoved:boolean
whether the text box has moved
data.handles.textBox.worldBoundingBox?
optionalworldBoundingBox:object
text box bounding box information
data.handles.textBox.worldBoundingBox.bottomLeft
bottomLeft:
Point3
Bottom left location of the text box in the world space
data.handles.textBox.worldBoundingBox.bottomRight
bottomRight:
Point3
Bottom right location of the text box in the world space
data.handles.textBox.worldBoundingBox.topLeft
topLeft:
Point3
Top left location of the text box in the world space
data.handles.textBox.worldBoundingBox.topRight
topRight:
Point3
Top right location of the text box in the world space
data.handles.textBox.worldPosition?
optionalworldPosition:Point3
the world location of the text box
deleting
deleting:
boolean
Inherited from
AnnotationTool.createAnnotationState
Defined in
tools/src/tools/base/AnnotationTool.ts:491
createZoomPanMemo()
staticcreateZoomPanMemo(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
hydrate()
statichydrate(viewportId,points,text?,options?):ArrowAnnotation
Parameters
• viewportId: string
• points: Point3[]
• text?: string
• options?
• options.annotationUID?: string
Returns
Defined in
tools/src/tools/annotation/ArrowAnnotateTool.ts:79
isSuvScaled()
staticisSuvScaled(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
Defined in
tools/src/tools/base/AnnotationTool.ts:386
mergeDefaultProps()
staticmergeDefaultProps(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