| 1234567891011121314151617181920212223242526272829303132333435 |
- import { GeoJsonProperties, Feature, Polygon } from 'geojson';
- import { Coord, Units } from '@turf/helpers';
- /**
- * Creates a circular sector of a circle of given radius and center {@link Point},
- * between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.
- *
- * @function
- * @param {Coord} center center point
- * @param {number} radius radius of the circle
- * @param {number} bearing1 angle, in decimal degrees, of the first radius of the sector
- * @param {number} bearing2 angle, in decimal degrees, of the second radius of the sector
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians
- * @param {number} [options.steps=64] number of steps
- * @param {Properties} [options.properties={}] Translate properties to Feature Polygon
- * @returns {Feature<Polygon>} sector polygon
- * @example
- * 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];
- */
- declare function sector(center: Coord, radius: number, bearing1: number, bearing2: number, options?: {
- steps?: number;
- units?: Units;
- properties?: GeoJsonProperties;
- }): Feature<Polygon>;
- export { sector as default, sector };
|