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

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

$ npm install @turf/sector

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

$ npm install @turf/turf

Readme

Keywords

Package Sidebar

Install

npm i @turf/sector

Weekly Downloads

305,315

Version

7.0.0

License

MIT

Unpacked Size

20 kB

Total Files

9

Last publish

Collaborators

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