パッケージの詳細

react-boxplot

paulmelnikow9.2kBSD-2-Clause4.0.0

Simple SVG box plots in React

react, chart, boxplot, svg

readme

react-boxplot

Simple SVG box plots in React

version license build code style

Install

yarn add react-boxplot
npm install --save react-boxplot

Usage

import React, { Component } from 'react'
import Boxplot, { computeBoxplotStats } from 'react-boxplot'

const values = [
  14, 15, 16, 16, 17, 17, 17, 17, 17, 18, 18, 18, 18, 18, 18, 19, 19, 19, 20,
  20, 20, 20, 20, 20, 21, 21, 22, 23, 24, 24, 29,
]

const Example = () => (
  <Boxplot
    width={400}
    height={20}
    orientation="horizontal"
    min={0}
    max={30}
    stats={computeBoxplotStats(values)}
  />
)

Or you can compute the stats yourself:

const Example = () => (
  <Boxplot
    width={400}
    height={25}
    orientation="horizontal"
    min={0}
    max={300}
    stats={{
      whiskerLow: 194.3,
      quartile1: 201,
      quartile2: 234.5,
      quartile3: 254.6,
      whiskerHigh: 257.95,
      outliers: [50, 75, 184.25, 268, 290],
    }}
  />
)

Features

  • Pure SVG
  • Horizonal or vertical orientation
  • The coordinate system of the major axis matches the original data

Development

In one terminal, start the build for the library:

npm ci
npm start

And, in a second terminal, start the build for the example app:

cd example
npm ci
npm start

Contribute

Pull requests welcome!

Acknowledgements

This library was developed by Paul Melnikow while working at Body Labs. This is a fork of the original repo, now abandoned, being maintained by its original author.

License

The project is licensed under the two-clause BSD license.

更新履歴

Changelog

4.0.0 -- Feb 10, 2022

  • BREAKING CHANGE: Make Boxplot the default export.
  • Add TypeScript typings.
  • Support React 17.

3.l.0 -- Jan 1, 2019

  • Support React 16.8.
  • Upgrade to Babel 7 and Rollup 1.
  • Switch test runner back to Mocha.
  • Update example app.

3.0.1 -- Jan 1, 2019

Fix publishing error from previous.

3.0.0 -- Jan 1, 2019

  • Update simple-statistics to 7.0.0, dropping support for IE11.

2.0.1 -- Dec 17, 2018

Update build dependencies.

2.0.0 -- Nov 19, 2018

Update dependencies. There is a breaking change in [simple-statistics][]. Whereas invalid values used to return NaN, they now raise an exception.

1.1.0

For compatibility with CSS in JS, pass through className property from Boxplot to the enclosed svg element.

1.0.0

Modernize the project using create-react-library.

The API is entirely the same, though it's now imported differently.

0.4.0

  • Support React 16 (@jonrovira)
  • Update for bodylabs -> paulmelnikow