fast-wind-rose v1.0.3

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.
2. Adaptive set attributes to determine the look and size.

Installation

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

# 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.

import Windrose from 'fast-wind-rose';

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

Usage

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

License

MIT