Editable annotations and persistent selection overlays

[mattpap]

Extracted relevant changes from PR #12074.

TODO:

• investigate not working modes with select_every_mousemove
• limit editability when dimension != "both"
• persist the overlay when switching tools (allow pan, zoom, etc.)
• better editability for origin == "center"
• redesign RangeTool using editable annotations
• add support for move/resize limits
• allow event propagation (e.g. hover passthrough)
• allow alt key to override select_every_mousemove
• resolve corner cases of overlay persistence across tool switching
• add interactive visual integration tests

These are partially done in separate work:

• formalize multiple selection overlay support
• add support for resize/move handles

Example (from #12074, but it works the same here):

Screencast.2022-04-01.23.53.28.mp4

• fixes Add support for persistent selection overlays #3412
• fixes PolySelectTool area remains the same at all zoom levels #5829
• fixes HoverTool not working with RangeTool #8180
• fixes [BUG] Can't interact with multiple RangeTools #9047
• fixes [BUG] range_tool broken on inverted axes #9381
• fixes [BUG] Possible regression: pinching not working with wheelzoomtool #12731

[codecov]

Codecov Report

Merging #12468 (10ca016) into branch-3.1 (d354c6a) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@              Coverage Diff               @@
##           branch-3.1   #12468      +/-   ##
==============================================
+ Coverage       92.29%   92.30%   +0.01%     
==============================================
  Files             314      314              
  Lines           19727    19755      +28     
==============================================
+ Hits            18207    18235      +28     
  Misses           1520     1520              

[ianthomas23]

Thanks, this is really useful functionality.

For the TODO of limit editability when dimensions != "both" do we need an equivalent dimensions property on BoxAnnotation and limit BoxAnnotationView._hit_test() to exclude checking hits_top and hits_bottom if dimensions == "width" (and similar for dimensions == "height")? Oh, we would also need to limit dragging to the appropriate dimension.

Another possible item for the TODO list is support for origin == "center" in BoxAnnotation as well as BoxSelectTool so that editing of the box remains symmetric about the center.

For persisting of the overlay when switching tools I've had some success in other work by switching the BoxAnnotation coordinates to data units when the BoxSelectTool is inactive, and back to canvas units when active.

[ianthomas23]

All my comments have been dealt with, so I am approving this.

There are some test failures.

[mattpap]

This is fully ready now. More testing and documentation will follow next week. Unless there are any objections, I would like to merged this soon.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.