This package has been deprecated

Author message:

Module has been renamed to @turf/point-on-feature

@turf/point-on-surface
TypeScript icon, indicating that this package has built-in type declarations

4.7.3 • Public • Published

@turf/point-on-surface

pointOnSurface

Takes a feature and returns a Point guaranteed to be on the surface of the feature.

  • Given a Polygon, the point will be in the area of the polygon
  • Given a LineString, the point will be along the string
  • Given a Point, the point will the same as the input

Parameters

Examples

// create a random polygon
var polygon = turf.random('polygon');

var pointOnPolygon = turf.pointOnSurface(polygon);

//addToMap
var addToMap = [polygon, pointOnPolygon];

Returns Feature a point on the surface of input


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/point-on-surface

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/point-on-surface

Weekly Downloads

1,184

Version

4.7.3

License

MIT

Last publish

Collaborators

  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly