Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: hilight remove fn assumes coords not changed #101

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kylezeeuwen
Copy link

Thank you for the great library !

I am using it in https://github.com/Displayr/rhtmlLabeledScatter which is a scatter / bubble plot library I have inherited and am heavily recfactoring. rbush has helped me clean up the collision detection logic used in the label placement algorithm.

I came across what I initially thought was a bug, but upon investigation it was me incorrectly using rbush.

The use case is that I am constantly moving the labels around, and checking for collisions. I observed that the remove call would not always remove the label rectangle. Upon investigating the remove implementation i realise that it optimises its tree traversal logic based on assumptions about the coordinates of the label rectangle. So if I change the x/y coords then call remove, sometimes the object would not get removed from the tree !

See the updates to the docs I made to hopefully save others some time.
Happy to change wording/format etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant