File size: 3,141 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
import clsx from 'clsx';
import { select as d3Select } from 'd3-selection';
import { isEmpty } from 'lodash';
import PropTypes from 'prop-types';
import { createRef, Component } from 'react';
/**
* Provides foundation to use D3 within React.
*
* React is responsible for determining when a chart should be updated (e.g. whenever data changes or the browser is
* resized), while D3 is responsible for the actual rendering of the chart (which is performed via DOM operations that
* happen outside of React's control).
*
* This component makes use of new lifecycle methods that come with React 16.3. Thus, while this component (i.e. the
* container of the chart) is rendered during the 'render phase' the chart itself is only rendered during the 'commit
* phase' (i.e. in 'componentDidMount' and 'componentDidUpdate' methods).
*/
export default class D3Base extends Component {
static propTypes = {
className: PropTypes.string,
data: PropTypes.any, // required to detect changes in data
drawChart: PropTypes.func.isRequired,
getParams: PropTypes.func.isRequired,
};
state = {
data: null,
params: null,
drawChart: null,
getParams: null,
};
chartRef = createRef();
static getDerivedStateFromProps( nextProps, prevState ) {
let state = {};
if ( nextProps.data !== prevState.data ) {
state = { ...state, data: nextProps.data };
}
if ( nextProps.drawChart !== prevState.drawChart ) {
state = { ...state, drawChart: nextProps.drawChart };
}
if ( nextProps.getParams !== prevState.getParams ) {
state = { ...state, getParams: nextProps.getParams };
}
if ( ! isEmpty( state ) ) {
return { ...state, params: null };
}
return null;
}
componentDidMount() {
window.addEventListener( 'resize', this.updateParams );
this.drawChart();
}
shouldComponentUpdate( nextProps, nextState ) {
return (
( nextState.params !== null && this.state.params !== nextState.params ) ||
this.state.data !== nextState.data
);
}
componentDidUpdate() {
this.drawChart();
}
componentWillUnmount() {
window.removeEventListener( 'resize', this.updateParams );
this.deleteChart();
}
deleteChart() {
d3Select( this.chartRef.current ).selectAll( 'svg' ).remove();
}
/**
* Renders the chart, or triggers a rendering by updating the list of params.
*/
drawChart() {
if ( ! this.state.params ) {
this.updateParams();
return;
}
const svg = this.getContainer();
this.props.drawChart( svg, this.state.params );
}
getContainer() {
const { className } = this.props;
const { width, height } = this.state.params;
this.deleteChart();
const svg = d3Select( this.chartRef.current )
.append( 'svg' )
.attr( 'viewBox', `0 0 ${ width } ${ height }` )
.attr( 'preserveAspectRatio', 'xMidYMid meet' );
if ( className ) {
svg.attr( 'class', `${ className }__viewbox` );
}
return svg.append( 'g' );
}
updateParams = () => {
const params = this.state.getParams( this.chartRef.current );
this.setState( { params } );
};
render() {
return <div className={ clsx( 'd3-base', this.props.className ) } ref={ this.chartRef } />;
}
}
|