jtBaseApp/node_modules/@turf/tag

@turf/tag

tag

Takes a set of points and a set of polygons and/or multipolygons and performs a spatial join.

Parameters

• points FeatureCollection<Point> input points
• polygons FeatureCollection<(Polygon | MultiPolygon)> input (multi)polygons
• field string property in polygons to add to joined {} features
• outField string property in points in which to store joined property from polygons

Examples

var pt1 = turf.point([-77, 44]);
var pt2 = turf.point([-77, 38]);
var poly1 = turf.polygon([[
  [-81, 41],
  [-81, 47],
  [-72, 47],
  [-72, 41],
  [-81, 41]
]], {pop: 3000});
var poly2 = turf.polygon([[
  [-81, 35],
  [-81, 41],
  [-72, 41],
  [-72, 35],
  [-81, 35]
]], {pop: 1000});

var points = turf.featureCollection([pt1, pt2]);
var polygons = turf.featureCollection([poly1, poly2]);

var tagged = turf.tag(points, polygons, 'pop', 'population');

//addToMap
var addToMap = [tagged, polygons]

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/turf