turf-polygon

turf polygon module


Keywords
gis, geojson, turf, polygon
License
MIT
Install
npm install turf-polygon@1.0.0

Documentation

turf-polygon

build status

turf polygon module

turf.polygon(rings, properties)

Takes an array of LinearRings and optionally an Object with properties and returns a Polygon feature.

Parameters

parameter type description
rings Array.<Array.<Number>> an array of LinearRings
properties Object optional: a properties object

Example

var polygon = turf.polygon([[
 [-2.275543, 53.464547],
 [-2.275543, 53.489271],
 [-2.215118, 53.489271],
 [-2.215118, 53.464547],
 [-2.275543, 53.464547]
]], { name: 'poly1', population: 400});

//=polygon

Returns Feature.<Polygon>, a Polygon feature

Installation

Requires nodejs.

$ npm install turf-polygon

Tests

$ npm test