feat(annotations): rework annotation manager api and enable multi-manager setup

[sedghi]

Changes to Annotation Manager

Annotation state

we can now switch between different annotation managers via csTools.annotations.state.setAnnotationManager(manager) to set the annotation manager to get used to filter/add/show/save annotations (by default it is our FrameOfReferenceSpecificAnnotationManager) that stores and group annotations based on the FrameOfReferenceUID

Some methods in the annotation state has been modified to add annotationGroupSelector which can be element or a string that is passed inside the annotation manager and let the manager map those to a key (GroupKey) that is used to group annotations together. In the default annotation manager, the groupKey is the FrameOfReferenceUID; however, you can write custom managers that store annotations separately per viewportId, or timepoints (prior vs current reading) or readerId, etc.

Here are the changes

• getAnnotations(element, toolName) is now getAnnotations(toolName, annotationGroupSelector)
• addAnnotation(element, annotation) is now addAnnotation(annotation, annotationGroupSelector)
• getNumberOfAnnotations(toolName, frameOfReferenceUID) is now getNumberOfAnnotations(toolName, annotationGroupSelector)
• removeAnnotation(annotationUID, element) is now removeAnnotation(annotationUID)
• getAnnotation(annotationUID, element?) is now getAnnotation(annotationUID)
• removeAllAnnotations(element?) is now removeAllAnnotations() without argument

FrameOfReferenceSpecificAnnotationManager

• annotationManagers should implement a getGroupKey that receives the annotationGroupSelector and returns the key
• old get(FrameOfReferenceUID, toolName) has been replaced by getAnnotations(groupKey, toolName?)
• old getAnnotation now only needs annotationUID and not more arguments
• old getNumberOfAnnotations(toolName, frameOfReferenceUID) is now getNumberOfAnnotations(groupKey, toolName?)
• old addAnnotation(annotation) is now addAnnotation(annotation, groupKey)
• old removeAnnotation now only requires annotationUID
• old saveAnnotations(FrameOfReferenceUID, toolName?) is now saveAnnotations(groupKey?, toolName?)
• new method removeAnnotations(groupKey, toolName?)

[netlify]

✅ Deploy Preview for cornerstone-3d-docs ready!

Name	Link
🔨 Latest commit	038de94
🔍 Latest deploy log	https://app.netlify.com/sites/cornerstone-3d-docs/deploys/63feb0d5fc81590008ba02cf
😎 Deploy Preview	https://deploy-preview-442--cornerstone-3d-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[wayfarer3130]

Please add a function that takes an element and returns an annotation manager id to use rather than assuming that it is FOR or default. That really gives you the ability to add other annotation manager types in the future, or even switch between them on a viewport, eg add some FOR annotations, and then some volume specific annotations. Could then have a combined one for viewing/rendering, and a specific one depending on the state for adding/udpating. Or, two of them for two different clinicians interpretations for comparison purposes.

[wayfarer3130]

Almost there - just add the function
getAnnotationManagerId: (element) => getEnabledElement(element).FrameOfReferenceUID
in a single file, and export it/use it.
The idea is to avoid exposing any knowledge of what the ID is in all these files, so that it can be changed in a single place, or even injected as a custom function at some point externally

[Gabsha]

It seems here that the output of type of manager.getAnnotations could be undefined, but is being coerced into Annotations. Would it make sense to return an empty Array if annotations are undefined, to respect to return type?

[sedghi]

Good catch, thanks!