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

6.5.0 • Public • Published

@turf/sector

sector

Creates a circular sector of a circle of given radius and center Point, between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.

Parameters

  • center Coord center point
  • radius number radius of the circle
  • bearing1 number angle, in decimal degrees, of the first radius of the sector
  • bearing2 number angle, in decimal degrees, of the second radius of the sector
  • options Object Optional parameters (optional, default {})
    • options.units string miles, kilometers, degrees, or radians (optional, default 'kilometers')
    • options.steps number number of steps (optional, default 64)
    • options.properties Properties Translate properties to Feature Polygon (optional, default {})

Examples

var center = turf.point([-75, 40]);
var radius = 5;
var bearing1 = 25;
var bearing2 = 45;

var sector = turf.sector(center, radius, bearing1, bearing2);

//addToMap
var addToMap = [center, sector];

Returns Feature<Polygon> sector polygon


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/sector

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

$ npm install @turf/turf

Readme

Keywords

Package Sidebar

Install

npm i @turf/sector

Weekly Downloads

370,088

Version

6.5.0

License

MIT

Unpacked Size

11 kB

Total Files

7

Last publish

Collaborators

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