Package Exports

@turf/tag

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/tag) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

turf-tag

tag

Takes a set of points and a set of polygons and performs a spatial join.

Parameters

points FeatureCollection<Point> input points
polygons FeatureCollection<Polygon> input polygons
field string property in polygons to add to joined Point features
outField string property in points in which to store joined property from `polygons

Examples

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

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install turf-tag

Or install the Turf module that includes it as a function:

$ npm install turf