CC-163 Add annotation color as a tool in the layer's render tab #53
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
annotation layers
When a key is inserted in the localToolBinder, the "toJSON()" method is called on the tool. The JSON retrieved from this call is stringyfied and used as key. The "toJSON()" method acts differently on Tool and LegacyTool. When a LayerTool (inheriting from Tool) is created, the "jsonId" is returned by "toJSON()", the strinfigication of this value leads then to insert in the localToolBinder map "mykey" (with quotes) instead of simply mykey. This result in the need to explicitally use "JSON.stringify(...)" on a key before calling "removeJsonString(...)", which is not ideal. This patch on "removeJsonString" searches first for the key and fallsback on the "JSON.stringify(...)" if the key cannot be found in the first place.
seankmartin
reviewed
Dec 5, 2024
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.
Summary
This PR moves the widget for color management for local annotation from the annotation tab to the rendering tab, improving UI organization and aligning widget placement with its functionality.
Additionally, this PR fixes an issue in the
removeJsonStringfunction to handle tool keys, resolving inconsistencies caused by differences in thetoJSON()method acrossToolandLegacyToolclasses.Motivation
Relocating the widget enhances usability by grouping it with related options, reducing user confusion.
User Interaction
Widget Relocation: The widget previously located in the state tab is now found in the redering tab. This change simplifies navigation for users working with segment-related settings.
To notify the user that the default color widget moved to the "rendering tab", a new icon with a question mark is displayed in the local-annotation layer, next to the buttons that allows to create new annotations, with a tooltip stating what are the buttons used for, and where is located the color control.
Implementation
Widget Relocation:
Code Changes: Updates in
layer/annotation/index.tsmoved the initialization and rendering logic of the widget to the redering tab.removeJsonStringFix:Problem: The
toJSON()method forToolandLegacyToolbehaves differently. ForLayerTool(inheriting fromTool),toJSON()returns ajsonIdvalue, causing keys inlocalToolBinderto include quotes (e.g.,"mykey"instead ofmykey). This created mismatches when usingremoveJsonString(), as it required explicitJSON.stringify()calls.Solution: The fix first attempts to locate the key directly. If it is not found, it falls back to checking the
JSON.stringify()version. This approach ensures compatibility with bothToolandLegacyToolimplementations.