turf/packages/turf-boolean-clockwise

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

$ npm install @turf/boolean-clockwise

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

$ npm install @turf/turf