diff --git a/packages/tools/src/tools/base/AnnotationTool.ts b/packages/tools/src/tools/base/AnnotationTool.ts index 346801a0c..b09af5fab 100644 --- a/packages/tools/src/tools/base/AnnotationTool.ts +++ b/packages/tools/src/tools/base/AnnotationTool.ts @@ -116,6 +116,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool { } static toolName; + // =================================================================== // Abstract Methods - Must be implemented. // =================================================================== @@ -147,11 +148,12 @@ abstract class AnnotationTool extends AnnotationDisplayTool { /** * @abstract cancel Used to cancel the ongoing tool drawing and manipulation * + * @param element - The HTML element */ - abstract cancel(element: HTMLDivElement); + abstract cancel(element: HTMLDivElement): void; /** - * handleSelectedCallback Custom callback for when a handle is selected. + * @abstract handleSelectedCallback Custom callback for when a handle is selected. * * @param evt - The normalized mouse event * @param annotation - The annotation selected. @@ -166,7 +168,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool { ): void; /** - * Custom callback for when an annotation is selected + * @abstract toolSelectedCallback Custom callback for when an annotation is selected * * @param evt - The normalized mouse event * @param annotation - The `Annotation` to check. @@ -180,7 +182,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool { ): void; /** - * Returns true if the provided canvas coordinate tool is near the annotation + * @abstract isPointNearTool Returns true if the provided canvas coordinate tool is near the annotation * * @param element - The HTML element * @param annotation - The annotation to check @@ -201,7 +203,6 @@ abstract class AnnotationTool extends AnnotationDisplayTool { /** * @virtual Event handler for Cornerstone MOUSE_MOVE event. * - * * @param evt - The normalized mouse event * @param filteredAnnotations - The annotations to check for hover interactions * @returns True if the annotation needs to be re-drawn by the annotationRenderingEngine.