Update the docs to show the default limit and offset of getClusterLeaves #10403
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
Providing `null` as a limit worked great on my local dev machine with 3 leaves. When pushed to production it took me some time to figure out why I would get only 10 leaves, although 14 existed. I hope this small hint in the docs will save someone else this time.
|
|
karimnaaji
approved these changes
Mar 8, 2021
| @@ -226,8 +226,8 @@ class GeoJSONSource extends Evented implements Source { | |||
| * For clustered sources, fetches the original points that belong to the cluster (as an array of GeoJSON features). | |||
| * | |||
| * @param clusterId The value of the cluster's `cluster_id` property. | |||
| * @param limit The maximum number of features to return. | |||
| * @param offset The number of features to skip (e.g. for pagination). | |||
| * @param limit The maximum number of features to return. (Defaults to `10` if a falsy value is given.) | |||
There was a problem hiding this comment.
For the record, limit and offset defaults defined in supercluster: https://github.com/mapbox/supercluster/blob/41c28833fe79d53bc8882a4b9db866cefee795c0/index.js#L120
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.
Providing
nullas a limit worked great on my local dev machine with 3 leaves. When pushed to production it took me some time to figure out why I would get only 10 leaves, although 14 existed. I hope this small hint in the docs will save someone else this time.