# fast-wind-rose

> The FAST wind rose provides a visual representation of the relative wind.

Latest version **1.0.3** (published 2021-06-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install fast-wind-rose
pnpm add fast-wind-rose
yarn add fast-wind-rose
bun add fast-wind-rose
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-06-17 |
| First published | 2021-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 45.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Diodorus |
| Maintainers | diodorus |
| Keywords | wind, react |

## Links

- npm: https://www.npmjs.com/package/fast-wind-rose
- Repository: https://github.com/phalkone/fast-wind-rose
- Homepage: https://github.com/phalkone/fast-wind-rose#readme
- Issues: https://github.com/phalkone/fast-wind-rose/issues
- npm.io page: https://npm.io/package/fast-wind-rose

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^5.3.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-06-17

## README

# FAST wind rose

## Introduction

The FAST wind rose provides a **visual** representation of the relative wind. It was purposely written for FAST.

Main principles the FAST wind rose are:

1. **Simple** deploy as React component.
1. **Adaptive** set attributes to determine the look and size.

## Installation

You can install `fast-wind-rose` via Yarn or npm:

```bash
# If using Yarn:
yarn add fast-wind-rose

# If using npm:
npm install --save fast-wind-rose
```

The core component from react-fout-stager is `Windrose`.
This module can be required via ES imports or CommonJS require.

```js
import Windrose from 'fast-wind-rose';

// using require
const Windrose = require('fast-wind-rose');
```

## Usage

```jsx
import React from 'react'
import { render } from 'react-dom'
import Windrose from 'fast-wind-rose'
import mockData from './mocks'

render(
  <Windrose
    dirData={mockData.metrics[1].values}
    spdData={mockData.metrics[0].values}
    interval={1}
    sectorCount={12}
    size={500}
    legend
  />, document.getElementById('root'))
```

### PROPS & METHODS

Prop name | Type | Default | Description
----------|------|---------|-------------
commonKey | string | timestamp | Common key between direction and speed data
dirData   | object[] | | Array with directional data for the wind
dirKey    | string | value | Key for directional data
spdData   | object[] | | Array with speed data for the wind
spdKey    | string | value | Key for speed data
enlarge   | number | 1 | Scales the compilation scale against the viewbox. Choose a value lower than 1 to scale down and larger than 1 to scale up.
interval  | number | 1 | Fixed interval between data points specified in hours. For example if data points are every 30 min, then value should be 0.5
legend    | bool | | Hide or display legend
scale     | object | Shape | Scale of speeds with the linked color. Example as follows: { 0: 'rgb(60,95,156)', 5: 'rgb(94,131,188)' }
sectorArray | number[] | [4, 8, 12, 16, 24, 32, 36] | Array that defines the number of sectors the user can choose from.
sectorCount | custom | 12 | Default number of sectors. Must be included in sectorArray.
size       | number | 260 | Width/height of chart. Will be displayed in specified viewbox.

## License

[MIT](http://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/fast-wind-rose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._