match places filter

This block is part of the places group and was last modified in core v15.0.0.

match places filter condition v15.0.0

Tests one geo point against a places filter, normally one from places_parse_query. distance_m and count come back whether or not the filter matched, so you can re-answer any radius question from the result without calling again : which is what lets a radius slider move without a round trip. reason is a readable Dutch explanation you can show to the user.

In pins 3

geo point geo_point required v15.0.0
The point to test.
filter object required v15.0.0
A filter object, normally from places_parse_query.
max distance (m) number v15.0.0
Override the filter's radius for this call, without re-parsing the query. Empty uses the filter's own radius.

Out pins 7

matches condition v15.0.0
True when the point satisfies the filter. A negated filter matches when nothing is nearby.
distance (m) number v15.0.0
Distance to the nearest place of the filter's category, reported even when the filter did not match.
count number v15.0.0
How many places of that category sit within the radius.
nearest object v15.0.0
The nearest place, whether or not the filter matched.
reason value v15.0.0
Readable Dutch explanation, e.g. 3× basisschool binnen 500m; dichtstbij 212m.
success condition v15.0.0
True when the query ran. An empty result is still a success.
error value v15.0.0
Error code when the query could not run: PLACES_NOT_AVAILABLE, GEO_POINT_MISSING_LAT_OR_LON, FILTER_REQUIRED.

A typical wiring for match places filter: from city feeds the geo_point pin; new object feeds the filter pin; the matches out pin feeds branch.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v15.0.0.

Back to places Return to the main group to view all sub-groups Back to Places Return to the group to view all blocks within this group