Windrose is a javascript browser/node module that converts compass degrees into compass points and vice versa.
npm install windrose --save
bower install windrose --save
var Windrose = require('windrose');
Windrose.getPoint(225); /* returns { symbol: 'SW', name: 'South West', depth: 1 } */
Windrose.getPoint(236.25); /* returns { symbol: SWbW, name: 'South West by West', depth: 3 } */
Windrose.getPoint(236.25, { depth: 0 }); /* returns { symbol: 'W', name: 'West', depth: 0 } */
Windrose.getDegrees('S'); /* returns { min: 174.375, value: 180, max: 185.625 } */
Windrose.getDegrees('South'); /* returns { min: 174.375, value: 180, max: 185.625 } */
Windrose.getDegrees('S', { depth: 0 }); /* returns { min: 135, value: 180, max: 225 } */Just include it in your html:
<script type="text/javascript" src="windrose.js">
The Windrose object will be available in your global scope.
It also supports AMD.
-
degrees(number) the degrees to convert to point (only valid if >= 0 or <= 360) -
opts(object) options hash [optional]depth(integer) the depth of search it can be a value between 0 and 3.
With value
0, it only returns the 4 main compass points (N, E, S, W).With value
1returns the main 8 compass points (N, NE, E, SE, S, SW, W, NW).With value
2returns the main 16 compass points (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW).With value
3returns the 32 points of the compass.With value
4returns the 64 points of the compass.With value
5returns the 128 points of the compass.Any other value will return
undefined.
name(string) the name or symbol of the compass point to convert to degreesopts(object) options hash [optional]depth(integer) the depth of search it can be a value between 0 and 5.
Copyright (c) 2015 Rogério Vicente. Licensed under the MIT license.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent