IMHO two parameters were not named clearly, so renaming
- line_props ->handle_props
- maxdist ->handle_grab_distance
Minor improvements:
- document default forbuttons
- document default fordrag_from_anywhere
- properly documentonselect

Heads up: I also see a naming issue withinteractive (see#20113 (comment)), but it's unclear if we should go back to the oldspan_stay or a different new name. To be discussed in tomorrows dev call. This can be addressed separately from this PR.

timhoffm added the topic: widgets/UI label

Jun 30, 2021

timhoffm added this to thev3.5.0 milestone

Jun 30, 2021

Rename recently introduced parameters in SpanSelector

81ca0cb

timhoffm force-pushed thespan-selector branch from8bb01f4 to81ca0cbCompare

June 30, 2021 22:06

QuLogic approved these changes

Jul 1, 2021

View reviewed changes

Copy link

Member

ericpre commentedJul 1, 2021

Indeed, the new names aremuch better, would it make sense to also rename these forRectangleSelector/EllipseSelector?

I agree with#20113 (comment) that the name doesn't describe completely what it does. However,persistent is not good enough, as wasspan_stays, because it doesn't describe the fact that the selector can be changed "interactively" using the handle.
The motivation in renaming it tointeractive in#20113 was to improve the consistency withRectangleSelector/EllipseSelector.

Maybe a better way to do this is to addpersistent alongsideinteractive_handle (or something similar)? This will allow the case where the selector patch stays on the axis (is persistent) but is not interactive?interactive_handle=True will need to setpersistent=True. Even if this makes the API of the selector slightly more complicated by adding more argument, the meaning of the arguments are more clear!