Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(AnnotationTool): update JSDoc comments #1702

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(AnnotationTool): update JSDoc comments #1702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions packages/tools/src/tools/base/AnnotationTool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
}

static toolName;

// ===================================================================
// Abstract Methods - Must be implemented.
// ===================================================================
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand Down
Loading