tag

Description

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

Parameters

Name	Type	Description
points	FeatureCollection<Point>	input points
polygons	FeatureCollection<Polygon | MultiPolygon>	input (multi)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

Returns

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

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");

Installation

$ npm install @turf/tag

import { tag } from "@turf/tag";
const result = tag(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.tag(...);