Package Exports

@turf/boolean-clockwise
@turf/boolean-clockwise/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/boolean-clockwise) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/boolean-clockwise

booleanClockwise

Takes a ring and return true or false whether or not the ring is clockwise or counter-clockwise.

Parameters

line (Feature<LineString> | LineString | Array<Array<number>>) to be evaluated

Examples

var clockwiseRing = turf.lineString([[0,0],[1,1],[1,0],[0,0]]);
var counterClockwiseRing = turf.lineString([[0,0],[1,0],[1,1],[0,0]]);

turf.booleanClockwise(clockwiseRing)
//=true
turf.booleanClockwise(counterClockwiseRing)
//=false

Returns boolean true/false

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 single module individually:

$ npm install @turf/boolean-clockwise

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf