match places filter
This block is part of the places group and was last modified in core v15.0.0.
match places filter 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.
- geo point required
v15.0.0geo_pointThe point to test.
- filter required
v15.0.0objectA filter object, normally from
places_parse_query. - max distance (m)
v15.0.0numberOverride the filter's radius for this call, without re-parsing the query. Empty uses the filter's own radius.
- matches
v15.0.0conditionTrue when the point satisfies the filter. A negated filter matches when nothing is nearby.
- distance (m)
v15.0.0numberDistance to the nearest place of the filter's category, reported even when the filter did not match.
- count
v15.0.0numberHow many places of that category sit within the radius.
- nearest
v15.0.0objectThe nearest place, whether or not the filter matched.
- reason
v15.0.0valueReadable Dutch explanation, e.g.
3× basisschool binnen 500m; dichtstbij 212m. - success
v15.0.0conditionTrue when the query ran. An empty result is still a success.
- error
v15.0.0valueError code when the query could not run:
PLACES_NOT_AVAILABLE,GEO_POINT_MISSING_LAT_OR_LON,FILTER_REQUIRED.
Core Releases
v15.0.0 This block was introduced inv15.0.0, click here to see the release notes. 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