Brush Interaction for XY-chart

packages/demo/examples/01-xy-chart/LinkedXYCharts.jsx

@@ -87,7 +87,10 @@ class LinkedXYCharts extends React.Component {
 
   handleMouseMove({ datum, seriesKey }) {
     if (this.state.mousedOverDatum !== datum || this.state.mousedOverKey !== seriesKey) {
-      this.setState(() => ({ mousedOverDatum: datum, mousedOverKey: seriesKey }));
+      this.setState(() => ({
+        mousedOverDatum: datum,
+        mousedOverKey: seriesKey,
+      }));
     }
   }
 
@@ -117,7 +120,12 @@ class LinkedXYCharts extends React.Component {
       : null;
 
     const stackCrossHairData = mousedOverDatum
-      ? { datum: { ...mousedOverDatum, y: getYForKey(mousedOverDatum, mousedOverKey) } }
+      ? {
+          datum: {
+            ...mousedOverDatum,
+            y: getYForKey(mousedOverDatum, mousedOverKey),
+          },
+        }
       : null;
 
     return (

packages/demo/examples/01-xy-chart/ScatterWithHistograms.jsx

@@ -36,8 +36,18 @@ export const pointData = genRandomNormalPoints(n).forEach(([x, y], i) => {
 });
 
 const marginScatter = { top: 10, right: 10, bottom: 64, left: 64 };
-const marginTopHist = { top: 10, right: marginScatter.right, bottom: 5, left: marginScatter.left };
-const marginSideHist = { top: 10, right: marginScatter.bottom, bottom: 5, left: marginScatter.top };
+const marginTopHist = {
+  top: 10,
+  right: marginScatter.right,
+  bottom: 5,
+  left: marginScatter.left,
+};
+const marginSideHist = {
+  top: 10,
+  right: marginScatter.bottom,
+  bottom: 5,
+  left: marginScatter.top,
+};
 
 // eslint-disable-next-line react/prop-types
 function renderTooltip({ datum }) {
@@ -104,7 +114,13 @@ class ScatterWithHistogram extends React.PureComponent {
 
   renderRightHistogram({ width, height }) {
     return (
-      <div style={{ transform: 'rotate(90deg)', display: 'flex', alignItems: 'flex-end' }}>
+      <div
+        style={{
+          transform: 'rotate(90deg)',
+          display: 'flex',
+          alignItems: 'flex-end',
+        }}
+      >
         <Histogram
           width={width}
           height={height}
@@ -178,7 +194,10 @@ class ScatterWithHistogram extends React.PureComponent {
           {this.renderTopHistogram({ width: scatterSize, height: histSize })}
           <div style={{ display: 'flex', flexDirection: 'row' }}>
             {this.renderScatter({ width: scatterSize, height: scatterSize })}
-            {this.renderRightHistogram({ width: scatterSize, height: histSize })}
+            {this.renderRightHistogram({
+              width: scatterSize,
+              height: histSize,
+            })}
           </div>
         </div>
         <Checkbox

packages/demo/examples/01-xy-chart/TickLabelPlayground.jsx

@@ -240,7 +240,11 @@ class TickLabelPlayground extends React.PureComponent {
                 type="radio"
                 value="left"
                 onChange={e =>
-                  this.setState({ axisOrientation: e.target.value, textAnchor: 'end', dx: -4 })
+                  this.setState({
+                    axisOrientation: e.target.value,
+                    textAnchor: 'end',
+                    dx: -4,
+                  })
                 }
                 checked={this.state.axisOrientation === 'left'}
               />{' '}
@@ -251,7 +255,11 @@ class TickLabelPlayground extends React.PureComponent {
                 type="radio"
                 value="right"
                 onChange={e =>
-                  this.setState({ axisOrientation: e.target.value, textAnchor: 'start', dx: 4 })
+                  this.setState({
+                    axisOrientation: e.target.value,
+                    textAnchor: 'start',
+                    dx: 4,
+                  })
                 }
                 checked={this.state.axisOrientation === 'right'}
               />{' '}

packages/demo/examples/01-xy-chart/data.js

@@ -12,7 +12,10 @@ export const timeSeriesData = appleStock.filter((d, i) => i % 120 === 0).map(d =
   y: d.close,
 }));
 
-export const categoricalData = letterFrequency.map(d => ({ x: d.letter, y: d.frequency }));
+export const categoricalData = letterFrequency.map(d => ({
+  x: d.letter,
+  y: d.frequency,
+}));
 
 // stacked data
 export const groupKeys = Object.keys(cityTemperature[0]).filter(attr => attr !== 'date');

packages/demo/examples/01-xy-chart/index.jsx

@@ -52,6 +52,7 @@ import {
 import WithToggle from '../shared/WithToggle';
 
 import computeForceBasedCirclePack from './computeForceBasedCirclePack';
+import BrushableLineChart from './BrushableLineChart';
 
 PatternLines.displayName = 'PatternLines';
 LinearGradient.displayName = 'LinearGradient';
@@ -303,6 +304,11 @@ export default {
       components: [XYChart, StackedBarSeries, AreaSeries, CrossHair],
       example: () => <LinkedXYCharts />,
     },
+    {
+      description: 'Brushable time series chart',
+      components: [XYChart, LineSeries],
+      example: () => <BrushableLineChart />,
+    },
     {
       description: 'StackedAreaSeries',
       components: [XYChart],

packages/demo/examples/02-histogram/HistogramPlayground.jsx

@@ -65,8 +65,20 @@ class HistogramPlayground extends React.PureComponent {
 
     this.state = {
       datasets: [0, 1],
-      0: getDataset({ n: NUM_POINTS, mu: 0, sigma: 1, distribution: 'normal', color: colors[0] }),
-      1: getDataset({ n: NUM_POINTS, mu: 2, sigma: 1, distribution: 'normal', color: colors[1] }),
+      0: getDataset({
+        n: NUM_POINTS,
+        mu: 0,
+        sigma: 1,
+        distribution: 'normal',
+        color: colors[0],
+      }),
+      1: getDataset({
+        n: NUM_POINTS,
+        mu: 2,
+        sigma: 1,
+        distribution: 'normal',
+        color: colors[1],
+      }),
 
       cumulative: false,
       normalized: false,

packages/xy-chart/src/chart/Voronoi.jsx

@@ -10,6 +10,7 @@ const propTypes = {
   onClick: PropTypes.func,
   onMouseMove: PropTypes.func,
   onMouseLeave: PropTypes.func,
+  onMouseDown: PropTypes.func,
   showVoronoi: PropTypes.bool,
   width: PropTypes.number.isRequired,
   height: PropTypes.number.isRequired,
@@ -21,6 +22,7 @@ const defaultProps = {
   onClick: null,
   onMouseMove: null,
   onMouseLeave: null,
+  onMouseDown: null,
   showVoronoi: false,
 };
 
@@ -31,8 +33,11 @@ class Voronoi extends React.PureComponent {
   }
 
   componentWillReceiveProps(nextProps) {
-    // eslint-disable-next-line react/destructuring-assignment
-    if (['data', 'x', 'y', 'width', 'height'].some(prop => this.props[prop] !== nextProps[prop])) {
+    if (
+      ['data', 'x', 'y', 'width', 'height'].some(
+        prop => this.props[prop] !== nextProps[prop], // eslint-disable-line react/destructuring-assignment
+      )
+    ) {
       this.setState({ voronoi: Voronoi.getVoronoi(nextProps) });
     }
   }
@@ -44,7 +49,7 @@ class Voronoi extends React.PureComponent {
   }
 
   render() {
-    const { onMouseLeave, onMouseMove, onClick, showVoronoi } = this.props;
+    const { onMouseLeave, onMouseMove, onClick, showVoronoi, onMouseDown } = this.props;
     const { voronoi } = this.state;
 
     return (
@@ -69,6 +74,7 @@ class Voronoi extends React.PureComponent {
               })
             }
             onMouseLeave={onMouseLeave && (() => onMouseLeave)}
+            onMouseDown={onMouseDown && (() => onMouseDown)}
           />
         ))}
       </Group>

packages/xy-chart/src/chart/XYChart.jsx

@@ -16,6 +16,7 @@ import {
   isCrossHair,
   isReferenceLine,
   isSeries,
+  isBrush,
   getChildWithName,
   numTicksForWidth,
   numTicksForHeight,
@@ -91,7 +92,9 @@ class XYChart extends React.PureComponent {
     this.handleClick = this.handleClick.bind(this);
     this.handleMouseLeave = this.handleMouseLeave.bind(this);
     this.handleMouseMove = this.handleMouseMove.bind(this);
+    this.handleMouseDown = this.handleMouseDown.bind(this);
     this.handleContainerEvent = this.handleContainerEvent.bind(this);
+    this.registerBrushStartEvent = this.registerBrushStartEvent.bind(this);
   }
 
   componentDidMount() {
@@ -107,8 +110,11 @@ class XYChart extends React.PureComponent {
 
   componentWillReceiveProps(nextProps) {
     let shouldComputeScales = false;
-    // eslint-disable-next-line react/destructuring-assignment
-    if (['width', 'height', 'children'].some(prop => this.props[prop] !== nextProps[prop])) {
+    if (
+      ['width', 'height', 'children'].some(
+        prop => this.props[prop] !== nextProps[prop], // eslint-disable-line react/destructuring-assignment
+      )
+    ) {
       shouldComputeScales = true;
     }
     if (
@@ -183,6 +189,16 @@ class XYChart extends React.PureComponent {
     }
   }
 
+  registerBrushStartEvent(event) {
+    this.fireBrushStart = event;
+  }
+
+  handleMouseDown(event) {
+    if (this.fireBrushStart) {
+      this.fireBrushStart(event);
+    }
+  }
+
   handleMouseMove(args) {
     const { snapTooltipToDataX, snapTooltipToDataY, onMouseMove } = this.props;
     const isFocusEvent = args.event && args.event.type === 'focus';
@@ -259,6 +275,10 @@ class XYChart extends React.PureComponent {
     const { numXTicks, numYTicks } = this.getNumTicks(innerWidth, innerHeight);
     const barWidth = xScale.barWidth || (xScale.bandwidth && xScale.bandwidth()) || 0;
     const CrossHairs = []; // ensure these are the top-most layer
+    let hasBrush = false;
+    let Brush;
+    let xAxisOrientation;
+    let yAxisOrientation;
 
     return (
       innerWidth > 0 &&
@@ -283,6 +303,11 @@ class XYChart extends React.PureComponent {
               const name = componentName(Child);
               if (isAxis(name)) {
                 const styleKey = name[0].toLowerCase();
+                if (name === 'XAxis') {
+                  xAxisOrientation = Child.props.orientation;
+                } else {
+                  yAxisOrientation = Child.props.orientation;
+                }
 
                 return React.cloneElement(Child, {
                   innerHeight,
@@ -322,6 +347,11 @@ class XYChart extends React.PureComponent {
                 return null;
               } else if (isReferenceLine(name)) {
                 return React.cloneElement(Child, { xScale, yScale });
+              } else if (isBrush(name)) {
+                hasBrush = true;
+                Brush = Child;
+
+                return null;
               }
 
               return Child;
@@ -335,6 +365,7 @@ class XYChart extends React.PureComponent {
                 width={innerWidth}
                 height={innerHeight}
                 onClick={this.handleClick}
+                onMouseDown={this.handleMouseDown}
                 onMouseMove={this.handleMouseMove}
                 onMouseLeave={this.handleMouseLeave}
                 showVoronoi={showVoronoi}
@@ -349,12 +380,26 @@ class XYChart extends React.PureComponent {
                 height={innerHeight}
                 fill="transparent"
                 fillOpacity={0}
+                onMouseDown={this.handleMouseDown}
                 onClick={this.handleContainerEvent}
                 onMouseMove={this.handleContainerEvent}
                 onMouseLeave={this.handleMouseLeave}
               />
             )}
 
+            {hasBrush &&
+              React.cloneElement(Brush, {
+                xScale,
+                yScale,
+                innerHeight,
+                innerWidth,
+                margin,
+                registerStartEvent:
+                  eventTrigger === SERIES_TRIGGER ? null : this.registerBrushStartEvent,
+                xAxisOrientation,
+                yAxisOrientation,
+              })}
+
             {tooltipData &&
               CrossHairs.length > 0 &&
               CrossHairs.map((CrossHair, i) =>

packages/xy-chart/src/index.js

@@ -25,3 +25,4 @@ export { PatternLines, PatternCircles, PatternWaves, PatternHexagons } from '@vx
 export { withScreenSize, withParentSize, ParentSize } from '@vx/responsive';
 export { default as withTheme } from './enhancer/withTheme';
 export { chartTheme as theme } from '@data-ui/theme';
+export { default as Brush } from './selection/Brush';