Skip to content

update setFilter jsdoc #9586

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.

Sign up for GitHub

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

Merged
danswick merged 1 commit into from
Apr 20, 2020
Merged

update setFilter jsdoc #9586

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/ui/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1795,19 +1795,35 @@ class Map extends Camera {
/**
* Sets the filter for the specified style layer.
*
* Filters control which features a style layer renders from its source.
* Any feature for which the filter expression evaluates to true will be
* rendered on the map. Those that are false will be hidden.
*
* Use setFilter to show a subset of your source data.
*
* To clear the filter, pass `null` or `undefined` as the second parameter.
*
* @param {string} layerId The ID of the layer to which the filter will be applied.
* @param {Array | null | undefined} filter The filter, conforming to the Mapbox Style Specification's
* [filter definition](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer.
* @param {Object} [options] Options object.
* @param {boolean} [options.validate=true] Whether to check if the filter conforms to the Mapbox GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
*
* @returns {Map} `this`
*
* @example
* // display only features with the 'name' property 'USA'
* map.setFilter('my-layer', ['==', ['get', 'name'], 'USA']);
* @example
* // display only features with five or more 'available-spots'
* map.setFilter('bike-docks', ['>=', ['get', 'available-spots'], 5]);
* @example
* map.setFilter('my-layer', ['==', 'name', 'USA']);
* // remove the filter for the 'bike-docks' style layer
* map.setFilter('bike-docks', null);
*
* @see [Filter features within map view](https://www.mapbox.com/mapbox-gl-js/example/filter-features-within-map-view/)
* @see [Highlight features containing similar data](https://www.mapbox.com/mapbox-gl-js/example/query-similar-features/)
* @see [Create a timeline animation](https://www.mapbox.com/mapbox-gl-js/example/timeline-animation/)
* @see [Tutorial: Show changes over time](https://docs.mapbox.com/help/tutorials/show-changes-over-time/)
*/
setFilter(layerId: string, filter: ?FilterSpecification, options: StyleSetterOptions = {}) {
this.style.setFilter(layerId, filter, options);
Expand Down