Socket
Socket
Sign inDemoInstall

turf-point-on-surface

Package Overview
Dependencies
8
Maintainers
9
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    turf-point-on-surface

turf point-on-surface module


Version published
Maintainers
9
Created

Readme

Source

turf-point-on-surface

build status

turf point-on-surface module

turf.point-on-surface(input)

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

parametertypedescription
inputFeature,FeatureCollectionany feature or set of features

Example

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

//=polygon

var pointOnPolygon = turf.pointOnSurface(polygon);

var resultFeatures = polygon.features.concat(pointOnPolygon);
var result = {
  "type": "FeatureCollection",
  "features": resultFeatures
};

//=result

Returns Feature, a point on the surface of input

Installation

Requires nodejs.

$ npm install turf-point-on-surface

Tests

$ npm test

Keywords

FAQs

Last updated on 16 May 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc