turf-tag

turf-tag

turf tag module

turf.tag(points, polygons, polyId, containingPolyId)

Takes a set of Point|points and a set of Polygon|polygons and performs a spatial join.

Parameters

parameter	type	description
points	FeatureCollection.<Point>	input points
polygons	FeatureCollection.<Polygon>	input polygons
polyId	String	property in polygons to add to joined Point features
containingPolyId	String	property in points in which to store joined property from `polygons

Example

var bbox = [0, 0, 10, 10];
// create a triangular grid of polygons
var triangleGrid = turf.triangleGrid(bbox, 50, 'miles');
triangleGrid.features.forEach(function(f) {
  f.properties.fill = '#' +
    (~~(Math.random() * 16)).toString(16) +
    (~~(Math.random() * 16)).toString(16) +
    (~~(Math.random() * 16)).toString(16);
  f.properties.stroke = 0;
  f.properties['fill-opacity'] = 1;
});
var randomPoints = turf.random('point', 30, {
  bbox: bbox
});
var both = turf.featurecollection(
  triangleGrid.features.concat(randomPoints.features));

//=both

var tagged = turf.tag(randomPoints, triangleGrid,
                      'fill', 'marker-color');

//=tagged

Returns FeatureCollection.<Point>, points with containingPolyId property containing values from polyId

Installation

Requires nodejs.

$ npm install turf-tag

Tests

$ npm test