com.mapbox.services.api.utils.turf

Class TurfGrids

java.lang.Object

com.mapbox.services.api.utils.turf.TurfGrids

public class TurfGrids
extends java.lang.Object

Methods found in this Turf class typically return a set of Point, Polygon, or other geometry in a grid.

Since:

1.3.0

See Also:

Turfjs documentation

Constructor Summary

Constructors

Constructor and Description
TurfGrids()

Method Summary

Modifier and Type	Method and Description
static com.mapbox.services.commons.geojson.FeatureCollection	within(com.mapbox.services.commons.geojson.FeatureCollection points, com.mapbox.services.commons.geojson.FeatureCollection polygons) Takes a FeatureCollection of Point and a FeatureCollection of Polygon and returns the points that fall within the polygons.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TurfGrids

public TurfGrids()

Method Detail

within

public static com.mapbox.services.commons.geojson.FeatureCollection within(com.mapbox.services.commons.geojson.FeatureCollection points,
                                                                           com.mapbox.services.commons.geojson.FeatureCollection polygons)

Takes a FeatureCollection of Point and a FeatureCollection of Polygon and returns the points that fall within the polygons.

Parameters:

points - input points.

polygons - input polygons.

Returns:

points that land within at least one polygon.

Since:

1.3.0