| 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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309 |
120x
120x
120x
120x
138x
26x
26x
26x
26x
26x
26x
26x
2x
9x
26x
85x
156x
153x
| import _ from 'lodash';
import React from 'react';
import { lucidClassNames } from '../../util/style-helpers';
import {
extractFields,
stackByFields,
} from '../../util/chart-helpers';
import { createClass, omitProps } from '../../util/component-types';
import * as d3Scale from 'd3-scale';
import * as chartConstants from '../../constants/charts';
import Bar from '../Bar/Bar';
import ToolTip from '../ToolTip/ToolTip';
import Legend from '../Legend/Legend';
const cx = lucidClassNames.bind('&-Bars');
const {
arrayOf,
func,
number,
object,
bool,
string,
} = React.PropTypes;
/**
* {"categories": ["visualizations", "chart primitives"], "madeFrom": ["Bar", "ToolTip", "Legend"]}
*
* *For use within an `svg`*
*
* Bars are typically used to represent categorical data and can be stacked or
* grouped.
*
*/
const Bars = createClass({
displayName: 'Bars',
propTypes: {
/**
* Appended to the component-specific class names set on the root element.
*/
className: string,
/**
* De-normalized data
*
* [
* { 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 },
* ]
*
*/
data: arrayOf(object).isRequired,
/**
* An object with human readable names for fields that will be used for
* tooltips. E.g:
*
* {
* rev: 'Revenue',
* imps: 'Impressions',
* }
*
*/
legend: object,
/**
* Show tool tips on hover.
*/
hasToolTips: bool,
/**
* 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,
/**
* The scale for the x axis. Must be a d3 band scale. Lucid exposes the
* `lucid.d3Scale.scaleBand` library for use here.
*/
xScale: func.isRequired,
/**
* The field we should look up your x data by.
*/
xField: string,
/**
* Function to format the x data.
*/
xFormatter: func,
/**
* 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(s) we should look up your y data by. Each entry represents a
* series. Your actual y data should be numeric.
*/
yFields: arrayOf(string),
/**
* Function to format the y data.
*/
yFormatter: func,
/**
* 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,
/**
* An optional function used to format your y axis titles and data in the
* tooltips. The first value is the name of your y field, the second value
* is your post-formatted y value, and the third value is your non-formatted
* y-value.
*
* Signature: `(yField, yValueFormatted, yValue) => {}`
*/
yTooltipFormatter: func,
/**
* This will stack the data instead of grouping it. 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,
/**
* Sometimes you might not want the colors to start rotating at the blue
* color, this number will be added the bar index in determining which
* color the bars are.
*/
colorOffset: number,
},
getDefaultProps() {
return {
hasToolTips: true,
xField: 'x',
xFormatter: _.identity,
yFields: ['y'],
yFormatter: _.identity,
yTooltipFormatter: (yField, yValueFormatted) => `${yField}: ${yValueFormatted}`,
isStacked: false,
colorOffset: 0,
palette: chartConstants.PALETTE_6,
};
},
getInitialState() {
return {
isHovering: false,
}
},
render() {
const {
className,
data,
legend,
hasToolTips,
palette,
colorMap,
colorOffset,
xScale,
xField,
xFormatter,
yScale: yScaleOriginal,
yFields,
yFormatter,
yStackedMax,
yTooltipFormatter,
isStacked,
...passThroughs,
} = this.props;
const {
isHovering,
hoveringSeriesIndex,
} = this.state;
// This scale is used for grouped bars
const innerXScale = d3Scale.scaleBand()
.domain(_.times(yFields.length))
.range([0, xScale.bandwidth()])
.round(true);
// 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
? stackByFields(data, yFields)
: extractFields(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).map((x) => _.last(_.last(x))).max().value(),
]);
}
return (
<g
{...omitProps(passThroughs, Bars)}
className={cx(className, '&')}
>
{_.map(transformedData, (series, seriesIndex) => (
<g key={seriesIndex}>
{_.map(series, ([start, end], pointsIndex) => (
<Bar
key={pointsIndex}
x={isStacked
? xScale(data[seriesIndex][xField])
: innerXScale(pointsIndex) + xScale(data[seriesIndex][xField])
}
y={yScale(end)}
height={yScale(start) - yScale(end)}
width={isStacked ? xScale.bandwidth() : innerXScale.bandwidth() }
color={_.get(colorMap, yFields[pointsIndex], palette[(pointsIndex + colorOffset) % palette.length])}
/>
))}
{hasToolTips ?
<ToolTip
isExpanded={isHovering && hoveringSeriesIndex === seriesIndex}
flyOutMaxWidth='none'
>
<ToolTip.Target elementType='g'>
<rect
className={cx('&-tooltip-hover-zone')}
height={isStacked
? yScale.range()[0] - yScale(_.last(series)[1])
: yScale.range()[0] - yScale(_.chain(series).flatten().max().value())
}
width={xScale.bandwidth()}
x={xScale(data[seriesIndex][xField])}
y={yScale(_.chain(series).flatten().max().value())}
onMouseOver={() => {
this.setState({
isHovering: true,
hoveringSeriesIndex: seriesIndex,
});
}}
onMouseOut={() => {
this.setState({ isHovering: false });
}}
/>
</ToolTip.Target>
<ToolTip.Title>
{xFormatter(data[seriesIndex][xField])}
</ToolTip.Title>
<ToolTip.Body>
<Legend hasBorders={false} isReversed={isStacked}>
{_.map(yFields, (field, fieldIndex) => (
<Legend.Item
key={fieldIndex}
hasPoint={true}
pointKind={1}
color={_.get(colorMap, field, palette[(fieldIndex + colorOffset ) % palette.length])}
>
{
yTooltipFormatter(_.get(legend, field, field),
yFormatter(data[seriesIndex][field]),
data[seriesIndex][field])
}
</Legend.Item>
))}
</Legend>
</ToolTip.Body>
</ToolTip>
: null}
</g>
))}
</g>
);
},
});
export default Bars;
|