0.3.0 • Published 8 years ago

react-liquidchart v0.3.0

Weekly downloads
19
License
BSD-2-Clause
Repository
github
Last release
8 years ago

React-liquidchart

Build Status Coverage Status

A Nice looking liquid chart done with d3 and react, based off http://bl.ocks.org/brattonc/5e5ce9beee483220e2f6

There is also another really nice version here

Install from NPM

npm install react-liquidchart

Example

For now, this will have to do.

Usage

import React, { Component } from 'react';
import { render } from 'react-dom';
import LiquidChart from 'react-liquidchart';

const stops = [
  <stop key={1} stopColor="someColor1" offset="5%" />
  <stop key={2} stopColor="someColor2" offset="50%" />,
  <stop key={3} stopColor="someColor3" offset="85%" />,
];

class ChartLiquid extends Component {
  constructor() {
    super();
  }

  render() {
    return (
      <div
        style={{
          width: '100%',
          height: '500px',
        }}
      >
        <LiquidChart
            responsive
            legend="Percentage of Completed Tasks"
            value={Math.random() * 100}
            showDecimal
            amplitude={4}
            frequency={2}
            animationTime={2000}
            animationWavesTime={2250}
            gradient={{
              type: 1,
              x1: 0,
              x2: 0,
              y1: 100,
              y2: 0,
              stops,
            }}
            postfix="%"
            legendFontSize={0.1}
          />
      </div>
    );
  }
}
render(<ChartLiquid />, document.getElementById('app'));

LiquidChart PropTypes

NameTypeDefaultDescription
WidthnumbernullThe width of the chart, used if responsive is false
heightnumbernullThe width of the chart, used if responsive is false
responsivebooltrueIf set to true then the element will fill out into parent container, and resize on window dimension change
Valuenumber0The value, tops at 100 and 0 is the minimum
animationWavesTimenumbernullThe speed of the wave animation, going back and forth
animationTimenumber2000milliseconds for animation when updating value
animationEasestring'easeCubicInOut'The name of the d3 easing function, other values like, easeBack, easeBackInOut, easeSinInOut, easeExpInOut. See d3 easing page for more ideas.
outerBoundnumber0.9This is the outerRadius of the chart where 1 would be 100% of the radius and 0 would be 0% of the radius..
innerBoundnumber0.8The innerwidth of the outerpath surronding the liquid, again 0.8 would be 80% of the radius.
marginnumber0.025The margin between the outer path and the liquid, here 0.025 would be 2.5%
amplitudenumber4The Amplitude X * sine(frequency) part of the formula
frequencynumber2The frequency, how many full circles are in the chart.
waveScaleLimitbooltrueThis is in the original, this will create a scale that limits the wave height close to 0 or 100
outerStyleshape{ fill: 'rgb(23,139,202)'}The style of the outerarc fill and stroke
liquidStyleshape{ fill: 'rgb(23, 139, 202)'}The style of the liquid, fill and stroke
dryStyleshape{fill: 'rgb(164, 219, 248)'}The style of the number that is not in the liquid, fill and stroke
wetStyleshape{fill: 'rgb(4, 86, 129)'}The style of the number that is in the liquid, fill and stroke
fontSizesshapeThe sizes of the fonts in ratio to the radius.
showDecimalboolfalseIf this is set then the decimal place is shown
postfixstringnullThe symbol that goes in the last tspan placeholder

Animation

There are two kinds of animation, the value animation and the back and forth animation. To set the animation you only need to set either the animationTime or the animationEase for value transitions. To set the back and forth animation you need to set the animationWavesTime prop.

fontSizes

Sets the fontsize of the tspans. The values are fractions of the radius.

const fontSize = {
  value: 0.6,
  decimal: 0.3,
  postfix: 0.1,
  legend: 0.1,
};

CSS

You can add your own css to the component by targeting the classes that are set.

For an example if I would like to change the font type and the positioning I could do something like this

  .liquid-text {
    transform: translate(0, 40px);
    font-family: Roboto;
  }

Licence

This software was available initially under the BSD-2-Clause. The changes are also available under the BSD-2-Clause.

0.3.0

8 years ago

0.2.13

8 years ago

0.2.12

8 years ago

0.2.11

9 years ago

0.2.1

9 years ago

0.2.0

9 years ago

0.1.14

9 years ago

0.1.13

9 years ago

0.1.12

9 years ago

0.1.11

9 years ago

0.1.1

9 years ago

0.1.0

9 years ago

0.0.16

9 years ago

0.0.14

9 years ago

0.0.13

9 years ago

0.0.12

9 years ago

0.0.11

9 years ago

0.0.1

9 years ago