fix(events): ANNOTATION_REMOVED event listener on removing ALL annotations. #1236
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for cornerstone-3d-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sedghi
reviewed
May 15, 2024
Comment on lines
279
to
284
| if (annotationToRemove !== null) { | ||
| triggerEvent(eventTarget, csToolEvents.ANNOTATION_REMOVED, { | ||
| annotation: annotationToRemove, | ||
| annotationManagerUID: this.uid, | ||
| }); | ||
| } |
There was a problem hiding this comment.
If you examine other sections in this file, we don't publish events here but rather in the annotationState. Could you perhaps follow the same pattern?
sedghi
reviewed
May 15, 2024
| @@ -223,16 +217,6 @@ function removeAnnotation(annotationUID: string): void { | |||
| ); | |||
|
|
|||
| manager.removeAnnotation(annotationUID); | |||
|
|
|||
| // trigger annotation removed | |||
| const eventType = Events.ANNOTATION_REMOVED; | |||
sedghi
reviewed
May 28, 2024
Comment on lines
257
to
262
| */ | ||
| function removeAnnotations(groupKey: string, toolName?: string): void { | ||
| const manager = getAnnotationManager(); | ||
| const removedAnnotations = manager.removeAnnotations(groupKey, toolName); | ||
|
|
||
| for (const annotation of removedAnnotations) { |
There was a problem hiding this comment.
I didn't expect this, why groupKey is part of the params? can you follow how other state functions behave please?
There was a problem hiding this comment.
I believe it is meant to be AnnotationGroupSelector instead of string? I will make this change as that is how other functions in this file handle this.
|
I made that function parameter more in-line with the other functions in that file. Thank you for these reviews. |
…/ChandlerClevenger/main
sedghi
approved these changes
Jun 5, 2024
sedghi
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Fixes #1056
Changes & Results
Moved code from FrameOfReferenceSpecificAnnotationManager into annotationState and re-used the same annotation removal code.
Testing
I used the annotationVisibility example and added another button to remove selected annotation OR if none are selected it would remove them all. I tested this way and it worked.
Checklist
PR
semantic-release format and guidelines.
Code
My code has been well-documented (function documentation, inline comments,
etc.)
I have run the
yarn build:update-apito update the API documentation, and havecommitted the changes to this PR. (Read more here https://www.cornerstonejs.org/docs/contribute/update-api)
N/A really
Public Documentation Updates
additions or removals.
Tested Environment