Skip to main content
Version: 6.5.0

tag

Description

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

Parameters

NameTypeDescription
pointsFeatureCollection<Point>input points
polygonsFeatureCollection<Polygon | MultiPolygon>input (multi)polygons
fieldstringproperty in polygons to add to joined {<Point>} features
outFieldstringproperty in points in which to store joined property from polygons

Returns

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(...);