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

Improve javadoc descriptions to marker clustering algorithms #1288

Open
wangela opened this issue Dec 15, 2023 · 0 comments · May be fixed by #1297
Open

Improve javadoc descriptions to marker clustering algorithms #1288

wangela opened this issue Dec 15, 2023 · 0 comments · May be fixed by #1297
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@wangela
Copy link
Member

wangela commented Dec 15, 2023

The marker clustering utility supports specifying custom clustering algorithms for various clustering scenarios. The current javadoc for algorithm types under com.google.maps.android.clustering.algo does not indicate which algorithm is best suited for which scenario.

We can reduce confusion by providing better guidance on which algorithm to select within the javadoc. For example, for clustering large numbers of markers (reported in #960 and #1199), we could modify the javadoc to read:

For managing large numbers of items (>1000 markers). This algorithm works the same way as {@link NonHierarchicalDistanceBasedAlgorithm} but works, only in visible area. It requires {@link shouldReclusterOnMapMovement} to be true in order to re-render clustering when camera movement changes the visible area.
@wangela wangela added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. triage me I really want to be triaged. type: docs Improvement to the documentation for an API. labels Dec 15, 2023
@wangela wangela added priority: p2 Moderately-important priority. Fix may not be included in next release. and removed triage me I really want to be triaged. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Dec 15, 2023
@kikoso kikoso linked a pull request Jan 19, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants