Skip to main content

abstractAnnotationTool

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.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

publicconfiguration

configuration: Record<string, any>

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Methods

abstractaddNewAnnotation

  • @abstract

    addNewAnnotation Creates a new annotation based on the clicked mouse position

    Parameters

    • evt: InteractionEventType

      The normalized mouse event

    • interactionType: InteractionTypes

      The interaction type used to add the annotation.

    Returns Annotation

publicapplyActiveStrategy

  • applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): 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.

publicapplyActiveStrategyCallback

  • applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): 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

    Returns any

    The result of the strategy.

abstractcancel

  • cancel(element: HTMLDivElement): any
  • @abstract

    cancel Used to cancel the ongoing tool drawing and manipulation

    Parameters

    • element: HTMLDivElement

    Returns any

filterInteractableAnnotationsForElement

  • 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 Annotations

    The filtered annotations

getHandleNearImagePoint

  • 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.

publicgetLinkedTextBoxStyle

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

  • It returns the style for the text box

    Parameters

    • specifications: StyleSpecifier
    • optionalannotation: Annotation

      The annotation for the tool that is currently active.

    Returns Record<string, unknown>

    An object of the style settings for the text box.

publicgetStyle

  • getStyle(property: string, specifications: StyleSpecifier, annotation?: 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
    • optionalannotation: Annotation

      The annotation for the tool that is currently active.

    Returns unknown

    The value of the property.

publicgetToolName

  • getToolName(): string

  • Returns the name of the tool

    Returns string

    The name of the tool.

abstracthandleSelectedCallback

  • 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

abstractisPointNearTool

  • isPointNearTool(element: HTMLDivElement, annotation: Annotation, canvasCoords: Point2, proximity: number, interactionType: string): boolean

  • Returns true if the provided canvas coordinate tool is near the annotation

    Parameters

    • element: HTMLDivElement

      The HTML element

    • annotation: Annotation

      The annotation to check

    • canvasCoords: Point2

      The canvas coordinate to check

    • proximity: number

      The minimum proximity to consider the point near

    • interactionType: string

      The interaction type used to select the tool.

    Returns boolean

    boolean if the point is near.

isSuvScaled

  • isSuvScaled(viewport: default | default, targetId: string, imageId?: string): boolean

  • Returns true if the viewport is scaled to SUV units

    Parameters

    • viewport: default | default

      The viewport

    • targetId: string

      The annotation targetId

    • optionalimageId: string

      The annotation imageId

    Returns boolean

publicmouseMoveCallback

  • mouseMoveCallback(evt: MouseMoveEventType, filteredAnnotations?: Annotations): boolean

  • Event handler for Cornerstone MOUSE_MOVE event.

    Parameters

    • evt: MouseMoveEventType

      The normalized mouse event

    • optionalfilteredAnnotations: Annotations

      The annotations to check for hover interactions

    Returns boolean

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

publiconImageSpacingCalibrated

  • onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): 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

abstractrenderAnnotation

  • @abstract

    renderAnnotation it used to draw the tool’s annotation in each request animation frame

    Parameters

    • enabledElement: IEnabledElement

      The Cornerstone’s enabledElement.

    • svgDrawingHelper: SVGDrawingHelper

      The svgDrawingHelper providing the context for drawing.

    Returns any

publicsetActiveStrategy

  • setActiveStrategy(strategyName: string): 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

publicsetConfiguration

  • setConfiguration(newConfiguration: Record<string, any>): void

  • merges the new configuration with the tool configuration

    Parameters

    • newConfiguration: Record<string, any>

    Returns void

abstracttoolSelectedCallback

  • 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.

    • optionalcanvasCoords: Point2

    Returns void

publicstaticcreateAndAddAnnotation

  • createAndAddAnnotation(viewport: any, ...annotationBaseData: any[]): 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
    • rest...annotationBaseData: any[]

    Returns void

publicstaticcreateAnnotation

  • createAnnotation(...annotationBaseData: any[]): Annotation

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

    Parameters

    • rest...annotationBaseData: any[]

    Returns Annotation

publicstaticcreateAnnotationForViewport

  • createAnnotationForViewport(viewport: any, ...annotationBaseData: any[]): 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
    • rest...annotationBaseData: any[]

    Returns Annotation