windbarb.src.js
17.7 KB
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
/**
* @license Highcharts JS v6.2.0 (2018-10-17)
* Wind barb series module
*
* (c) 2010-2018 Torstein Honsi
*
* License: www.highcharts.com/license
*/
'use strict';
(function (factory) {
if (typeof module === 'object' && module.exports) {
module.exports = factory;
} else if (typeof define === 'function' && define.amd) {
define(function () {
return factory;
});
} else {
factory(Highcharts);
}
}(function (Highcharts) {
var onSeriesMixin = (function (H) {
/**
* (c) 2010-2018 Torstein Honsi
*
* License: www.highcharts.com/license
*/
var each = H.each,
defined = H.defined,
seriesTypes = H.seriesTypes,
stableSort = H.stableSort;
var onSeriesMixin = {
/**
* Override getPlotBox. If the onSeries option is valid, return the plot box
* of the onSeries, otherwise proceed as usual.
*/
getPlotBox: function () {
return H.Series.prototype.getPlotBox.call(
(
this.options.onSeries &&
this.chart.get(this.options.onSeries)
) || this
);
},
/**
* Extend the translate method by placing the point on the related series
*/
translate: function () {
seriesTypes.column.prototype.translate.apply(this);
var series = this,
options = series.options,
chart = series.chart,
points = series.points,
cursor = points.length - 1,
point,
lastPoint,
optionsOnSeries = options.onSeries,
onSeries = optionsOnSeries && chart.get(optionsOnSeries),
onKey = options.onKey || 'y',
step = onSeries && onSeries.options.step,
onData = onSeries && onSeries.points,
i = onData && onData.length,
inverted = chart.inverted,
xAxis = series.xAxis,
yAxis = series.yAxis,
xOffset = 0,
leftPoint,
lastX,
rightPoint,
currentDataGrouping,
distanceRatio;
// relate to a master series
if (onSeries && onSeries.visible && i) {
xOffset = (onSeries.pointXOffset || 0) + (onSeries.barW || 0) / 2;
currentDataGrouping = onSeries.currentDataGrouping;
lastX = (
onData[i - 1].x +
(currentDataGrouping ? currentDataGrouping.totalRange : 0)
); // #2374
// sort the data points
stableSort(points, function (a, b) {
return (a.x - b.x);
});
onKey = 'plot' + onKey[0].toUpperCase() + onKey.substr(1);
while (i-- && points[cursor]) {
leftPoint = onData[i];
point = points[cursor];
point.y = leftPoint.y;
if (leftPoint.x <= point.x && leftPoint[onKey] !== undefined) {
if (point.x <= lastX) { // #803
point.plotY = leftPoint[onKey];
// interpolate between points, #666
if (leftPoint.x < point.x && !step) {
rightPoint = onData[i + 1];
if (rightPoint && rightPoint[onKey] !== undefined) {
// the distance ratio, between 0 and 1
distanceRatio = (point.x - leftPoint.x) /
(rightPoint.x - leftPoint.x);
point.plotY +=
distanceRatio *
// the plotY distance
(rightPoint[onKey] - leftPoint[onKey]);
point.y +=
distanceRatio *
(rightPoint.y - leftPoint.y);
}
}
}
cursor--;
i++; // check again for points in the same x position
if (cursor < 0) {
break;
}
}
}
}
// Add plotY position and handle stacking
each(points, function (point, i) {
var stackIndex;
point.plotX += xOffset; // #2049
// Undefined plotY means the point is either on axis, outside series
// range or hidden series. If the series is outside the range of the
// x axis it should fall through with an undefined plotY, but then
// we must remove the shapeArgs (#847). For inverted charts, we need
// to calculate position anyway, because series.invertGroups is not
// defined
if (point.plotY === undefined || inverted) {
if (point.plotX >= 0 && point.plotX <= xAxis.len) {
// We're inside xAxis range
if (inverted) {
point.plotY = xAxis.translate(point.x, 0, 1, 0, 1);
point.plotX = defined(point.y) ?
yAxis.translate(point.y, 0, 0, 0, 1) : 0;
} else {
point.plotY = chart.chartHeight - xAxis.bottom -
(xAxis.opposite ? xAxis.height : 0) +
xAxis.offset - yAxis.top; // #3517
}
} else {
point.shapeArgs = {}; // 847
}
}
// if multiple flags appear at the same x, order them into a stack
lastPoint = points[i - 1];
if (lastPoint && lastPoint.plotX === point.plotX) {
if (lastPoint.stackIndex === undefined) {
lastPoint.stackIndex = 0;
}
stackIndex = lastPoint.stackIndex + 1;
}
point.stackIndex = stackIndex; // #3639
});
this.onSeries = onSeries;
}
};
return onSeriesMixin;
}(Highcharts));
(function (H, onSeriesMixin) {
/**
* Wind barb series module
*
* (c) 2010-2018 Torstein Honsi
*
* License: www.highcharts.com/license
*/
var each = H.each,
noop = H.noop,
seriesType = H.seriesType;
/**
* Wind barbs are a convenient way to represent wind speed and direction in one
* graphical form. Wind direction is given by the stem direction, and wind speed
* by the number and shape of barbs.
*
* @extends plotOptions.column
* @excluding boostThreshold,marker,connectEnds,connectNulls,cropThreshold,
* dashStyle,gapSize,gapUnit,dataGrouping,linecap,shadow,stacking,
* step
* @product highcharts highstock
* @sample {highcharts|highstock} highcharts/demo/windbarb-series/
* Wind barb series
* @since 6.0.0
* @optionparent plotOptions.windbarb
*/
seriesType('windbarb', 'column', {
/**
* The line width of the wind barb symbols.
*/
lineWidth: 2,
/**
* The id of another series in the chart that the wind barbs are projected
* on. When `null`, the wind symbols are drawn on the X axis, but offset
* up or down by the `yOffset` setting.
*
* @sample {highcharts|highstock} highcharts/plotoptions/windbarb-onseries
* Projected on area series
* @type {String|null}
*/
onSeries: null,
states: {
hover: {
lineWidthPlus: 0
}
},
tooltip: {
/**
* The default point format for the wind barb tooltip. Note the
* `point.beaufort` property that refers to the Beaufort wind scale. The
* names can be internationalized by modifying
* `Highcharts.seriesTypes.windbarb.prototype.beaufortNames`.
*/
pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.value}</b> ({point.beaufort})<br/>'
},
/**
* Pixel length of the stems.
*/
vectorLength: 20,
/**
* Vertical offset from the cartesian position, in pixels. The default value
* makes sure the symbols don't overlap the X axis when `onSeries` is
* `null`, and that they don't overlap the linked series when `onSeries` is
* given.
*/
yOffset: -20,
/**
* Horizontal offset from the cartesian position, in pixels. When the chart
* is inverted, this option allows translation like
* [yOffset](#plotOptions.windbarb.yOffset) in non inverted charts.
*
* @since 6.1.0
*/
xOffset: 0
}, {
pointArrayMap: ['value', 'direction'],
parallelArrays: ['x', 'value', 'direction'],
beaufortName: ['Calm', 'Light air', 'Light breeze',
'Gentle breeze', 'Moderate breeze', 'Fresh breeze',
'Strong breeze', 'Near gale', 'Gale', 'Strong gale', 'Storm',
'Violent storm', 'Hurricane'],
beaufortFloor: [0, 0.3, 1.6, 3.4, 5.5, 8.0, 10.8, 13.9, 17.2, 20.8,
24.5, 28.5, 32.7],
trackerGroups: ['markerGroup'],
/**
* Get presentational attributes.
*/
pointAttribs: function (point, state) {
var options = this.options,
stroke = point.color || this.color,
strokeWidth = this.options.lineWidth;
if (state) {
stroke = options.states[state].color || stroke;
strokeWidth =
(options.states[state].lineWidth || strokeWidth) +
(options.states[state].lineWidthPlus || 0);
}
return {
'stroke': stroke,
'stroke-width': strokeWidth
};
},
markerAttribs: function () {
return undefined;
},
getPlotBox: onSeriesMixin.getPlotBox,
/**
* Create a single wind arrow. It is later rotated around the zero
* centerpoint.
*/
windArrow: function (point) {
var knots = point.value * 1.943844,
level = point.beaufortLevel,
path,
barbs,
u = this.options.vectorLength / 20,
pos = -10;
if (point.isNull) {
return [];
}
if (level === 0) {
return this.chart.renderer.symbols.circle(
-10 * u,
-10 * u,
20 * u,
20 * u
);
}
// The stem and the arrow head
path = [
'M', 0, 7 * u, // base of arrow
'L', -1.5 * u, 7 * u,
0, 10 * u,
1.5 * u, 7 * u,
0, 7 * u,
0, -10 * u// top
];
// For each full 50 knots, add a pennant
barbs = (knots - knots % 50) / 50; // pennants
if (barbs > 0) {
while (barbs--) {
path.push(
pos === -10 ? 'L' : 'M',
0,
pos * u,
'L',
5 * u,
pos * u + 2,
'L',
0,
pos * u + 4
);
// Substract from the rest and move position for next
knots -= 50;
pos += 7;
}
}
// For each full 10 knots, add a full barb
barbs = (knots - knots % 10) / 10;
if (barbs > 0) {
while (barbs--) {
path.push(
pos === -10 ? 'L' : 'M',
0,
pos * u,
'L',
7 * u,
pos * u
);
knots -= 10;
pos += 3;
}
}
// For each full 5 knots, add a half barb
barbs = (knots - knots % 5) / 5; // half barbs
if (barbs > 0) {
while (barbs--) {
path.push(
pos === -10 ? 'L' : 'M',
0,
pos * u,
'L',
4 * u,
pos * u
);
knots -= 5;
pos += 3;
}
}
return path;
},
translate: function () {
var beaufortFloor = this.beaufortFloor,
beaufortName = this.beaufortName;
onSeriesMixin.translate.call(this);
each(this.points, function (point) {
var level = 0;
// Find the beaufort level (zero based)
for (; level < beaufortFloor.length; level++) {
if (beaufortFloor[level] > point.value) {
break;
}
}
point.beaufortLevel = level - 1;
point.beaufort = beaufortName[level - 1];
});
},
drawPoints: function () {
var chart = this.chart,
yAxis = this.yAxis,
inverted = chart.inverted,
shapeOffset = this.options.vectorLength / 2;
each(this.points, function (point) {
var plotX = point.plotX,
plotY = point.plotY;
// Check if it's inside the plot area, but only for the X dimension.
if (chart.isInsidePlot(plotX, 0, false)) {
// Create the graphic the first time
if (!point.graphic) {
point.graphic = this.chart.renderer
.path()
.add(this.markerGroup);
}
// Position the graphic
point.graphic
.attr({
d: this.windArrow(point),
translateX: plotX + this.options.xOffset,
translateY: plotY + this.options.yOffset,
rotation: point.direction
})
.attr(this.pointAttribs(point));
} else if (point.graphic) {
point.graphic = point.graphic.destroy();
}
// Set the tooltip anchor position
point.tooltipPos = [
plotX + this.options.xOffset + (inverted && !this.onSeries ?
shapeOffset : 0),
plotY + this.options.yOffset - (inverted ? 0 :
shapeOffset + yAxis.pos - chart.plotTop)
]; // #6327
}, this);
},
/**
* Fade in the arrows on initiating series.
*/
animate: function (init) {
if (init) {
this.markerGroup.attr({
opacity: 0.01
});
} else {
this.markerGroup.animate({
opacity: 1
}, H.animObject(this.options.animation));
this.animate = null;
}
},
/**
* Don't invert the marker group (#4960)
*/
invertGroups: noop
}, {
isValid: function () {
return H.isNumber(this.value) && this.value >= 0;
}
});
/**
* A `windbarb` series. If the [type](#series.windbarb.type) option is not
* specified, it is inherited from [chart.type](#chart.type).
*
* @type {Object}
* @extends series,plotOptions.windbarb
* @excluding dataParser,dataURL
* @product highcharts highstock
* @apioption series.windbarb
*/
/**
* An array of data points for the series. For the `windbarb` series type,
* points can be given in the following ways:
*
* 1. An array of arrays with 3 values. In this case, the values correspond
* to `x,value,direction`. If the first value is a string, it is applied as
* the name of the point, and the `x` value is inferred.
*
* ```js
* data: [
* [Date.UTC(2017, 0, 1, 0), 3.3, 90],
* [Date.UTC(2017, 0, 1, 1), 12.1, 180],
* [Date.UTC(2017, 0, 1, 2), 11.1, 270]
* ]
* ```
*
* 2. An array of objects with named values. The following snippet shows only a
* few settings, see the complete options set below. If the total number of data
* points exceeds the series' [turboThreshold](#series.area.turboThreshold),
* this option is not available.
*
* ```js
* data: [{
* x: Date.UTC(2017, 0, 1, 0),
* value: 12.1,
* direction: 90
* }, {
* x: Date.UTC(2017, 0, 1, 1),
* value: 11.1,
* direction: 270
* }]
* ```
*
* @type {Array<Object|Array|Number>}
* @extends series.line.data
* @sample {highcharts} highcharts/chart/reflow-true/
* Numerical values
* @sample {highcharts} highcharts/series/data-array-of-arrays/
* Arrays of numeric x and y
* @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
* Arrays of datetime x and y
* @sample {highcharts} highcharts/series/data-array-of-name-value/
* Arrays of point.name and y
* @sample {highcharts} highcharts/series/data-array-of-objects/
* Config objects
* @product highcharts highstock
* @apioption series.windbarb.data
*/
/**
* The wind speed in meters per second.
*
* @type {Number}
* @product highcharts highstock
* @apioption series.windbarb.data.value
*/
/**
* The wind direction in degrees, where 0 is north (pointing towards south).
*
* @type {Number}
* @product highcharts highstock
* @apioption series.windbarb.data.direction
*/
}(Highcharts, onSeriesMixin));
return (function () {
}());
}));