All files / components/Points Points.jsx

100% Statements 16/16
81.25% Branches 13/16
100% Functions 3/3
100% Lines 16/16
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 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212                    120x                 120x     125x 6x 6x     119x                   120x                                                                                                                                                                                                                 120x                                                 25x     25x       25x           25x 1x           25x           40x 125x                                  
import _ from 'lodash';
import React from 'react';
import { lucidClassNames } from '../../util/style-helpers';
import { createClass, omitProps } from '../../util/component-types';
import { groupByFields } from '../../util/chart-helpers';
import * as d3Shape from 'd3-shape';
import * as chartConstants from '../../constants/charts';
 
import Point from '../Point/Point';
 
const cx = lucidClassNames.bind('&-Points');
 
const {
	arrayOf,
	func,
	number,
	object,
	bool,
	string,
} = React.PropTypes;
 
function isValidSeries(series) {
	if (_.isArray(series)) {
		const last = _.last(series);
		return _.isFinite(last) || _.isDate(last);
	}
 
	return _.isFinite(series) || _.isDate(series);
}
 
/**
 * {"categories": ["visualizations", "chart primitives"], "madeFrom": ["Point"]}
 *
 * *For use within an `svg`*
 *
 * Put some points on that data.
 */
const Points = createClass({
	displayName: 'Points',
 
	propTypes: {
		/**
		 * Appended to the component-specific class names set on the root element.
		 */
		className: string,
		/**
		 * Takes one of the palettes exported from `lucid.chartConstants`.
		 * Available palettes:
		 *
		 * - `PALETTE_6` (default)
		 * - `PALETTE_30`
		 * - `PALETTE_MONOCHROME_0_5`
		 * - `PALETTE_MONOCHROME_1_5`
		 * - `PALETTE_MONOCHROME_2_5`
		 * - `PALETTE_MONOCHROME_3_5`
		 * - `PALETTE_MONOCHROME_4_5`
		 * - `PALETTE_MONOCHROME_5_5`
		 *
		 */
		palette: arrayOf(string),
		/**
		 * You can pass in an object if you want to map fields to
		 * `lucid.chartConstants` or custom colors:
		 *
		 *     {
		 *       'imps': COLOR_0,
		 *       'rev': COLOR_3,
		 *       'clicks': '#abc123',
		 *     }
		 */
		colorMap: object,
		/**
		 * De-normalized data, e.g.
		 *
		 *
		 *     [
		 *       { x: 'one'   , y: 1 },
		 *       { x: 'two'   , y: 2 },
		 *       { x: 'three' , y: 2 },
		 *       { x: 'four'  , y: 3 },
		 *       { x: 'five'  , y: 4 },
		 *     ]
		 *
		 *
		 * Or (be sure to set `yFields` to `['y0', 'y1', 'y2', 'y3']`)
		 *
		 *     [
		 *       { x: 'one'   , y0: 1  , y1: 2 , y2: 3 , y3: 5 },
		 *       { x: 'two'   , y0: 2  , y1: 3 , y2: 4 , y3: 6 },
		 *       { x: 'three' , y0: 2  , y1: 4 , y2: 5 , y3: 6 },
		 *       { x: 'four'  , y0: 3  , y1: 6 , y2: 7 , y3: 7 },
		 *       { x: 'five'  , y0: 4  , y1: 8 , y2: 9 , y3: 8 },
		 *       { x: 'six'   , y0: 20 , y1: 8 , y2: 9 , y3: 1 },
		 *     ]
		 *
		 */
		data: arrayOf(object).isRequired,
		/**
		 * The scale for the x axis. Must be a d3 scale. Lucid exposes the
		 * `lucid.d3Scale` library for use here.
		 */
		xScale: func.isRequired,
		/**
		 * The scale for the y axis. Must be a d3 scale. Lucid exposes the
		 * `lucid.d3Scale` library for use here.
		 */
		yScale: func.isRequired,
		/**
		 * The field we should look up your x data by.
		 */
		xField: string,
		/**
		 * The field(s) we should look up your y data by. Each entry represents a
		 * series. Your actual y data should be numeric.
		 */
		yFields: arrayOf(string),
		/**
		 * Typically this number can be derived from the yScale. However when we're
		 * `isStacked` we need to calculate a new domain for the yScale based on
		 * the sum of the data. If you need explicit control of the y max when
		 * stacking, pass it in here.
		 */
		yStackedMax: number,
		/**
		 * Sometimes you might not want the colors to start rotating at the blue
		 * color, this number will be added the line index in determining which
		 * color the lines are.
		 */
		colorOffset: number,
		/**
		 * Display a stroke around each of the points.
		 */
		hasStroke: bool,
		/**
		 * This will stack the data. In order to stack the data we have to
		 * calculate a new domain for the y scale that is based on the `sum` of the
		 * data.
		 */
		isStacked: bool,
	},
 
	getDefaultProps() {
		return {
			xField: 'x',
			yFields: ['y'],
			colorOffset: 0,
			hasStroke: true,
			isStacked: false,
			palette: chartConstants.PALETTE_6,
		};
	},
 
	render() {
		const {
			className,
			data,
			palette,
			colorMap,
			colorOffset,
			xField,
			hasStroke,
			xScale,
			yFields,
			yStackedMax,
			isStacked,
			yScale: yScaleOriginal,
			...passThroughs,
		} = this.props;
 
		// Copy the original so we can mutate it
		const yScale = yScaleOriginal.copy();
 
		// If we are stacked, we need to calculate a new domain based on the sum of
		// the various series' y data. One row per series.
		const transformedData = isStacked
			? d3Shape.stack().keys(yFields)(data)
			: groupByFields(data, yFields);
 
		// If we are stacked, we need to calculate a new domain based on the sum of
		// the various group's y data
		if (isStacked) {
			yScale.domain([
				yScale.domain()[0],
				yStackedMax || _.chain(transformedData).last().flatten().max().value(),
			]);
		}
 
		return (
			<g
				{...omitProps(passThroughs, Points)}
				className={cx(className, '&')}
			>
				{_.map(transformedData, (d, dIndex) => (
					_.map(d, (series, seriesIndex) => (
						isValidSeries(series) ?
							<Point
								x={xScale(data[seriesIndex][xField])}
								y={yScale(_.isArray(series) ? _.last(series) : series)}
								hasStroke={hasStroke}
								kind={dIndex + colorOffset}
								color={_.get(colorMap, yFields[dIndex], palette[(dIndex + colorOffset) % palette.length])}
							/>
						: null
					))
				))}
			</g>
		);
	},
});
 
export default Points;