/**
* @license Highcharts JS v8.1.0 (2020-05-05)
*
* Wind barb series module
*
* (c) 2010-2019 Torstein Honsi
*
* License: www.highcharts.com/license
*/
'use strict';
(function (factory) {
if (typeof module === 'object' && module.exports) {
factory['default'] = factory;
module.exports = factory;
} else if (typeof define === 'function' && define.amd) {
define('highcharts/modules/windbarb', ['highcharts'], function (Highcharts) {
factory(Highcharts);
factory.Highcharts = Highcharts;
return factory;
});
} else {
factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
}
}(function (Highcharts) {
var _modules = Highcharts ? Highcharts._modules : {};
function _registerModule(obj, path, args, fn) {
if (!obj.hasOwnProperty(path)) {
obj[path] = fn.apply(null, args);
}
}
_registerModule(_modules, 'mixins/on-series.js', [_modules['parts/Globals.js'], _modules['parts/Utilities.js']], function (H, U) {
/* *
*
* (c) 2010-2020 Torstein Honsi
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
var defined = U.defined, stableSort = U.stableSort;
var seriesTypes = H.seriesTypes;
/**
* @private
* @mixin onSeriesMixin
*/
var onSeriesMixin = {
/* eslint-disable valid-jsdoc */
/**
* Override getPlotBox. If the onSeries option is valid, return the plot box
* of the onSeries, otherwise proceed as usual.
*
* @private
* @function onSeriesMixin.getPlotBox
* @return {Highcharts.SeriesPlotBoxObject}
*/
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
*
* @private
* @function onSeriesMixin.translate
* @return {void}
*/
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 &&
typeof 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 &&
typeof 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
points.forEach(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 (typeof 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 = (xAxis.opposite ? 0 : series.yAxis.len) +
xAxis.offset; // For the windbarb demo
}
}
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 (typeof lastPoint.stackIndex === 'undefined') {
lastPoint.stackIndex = 0;
}
stackIndex = lastPoint.stackIndex + 1;
}
point.stackIndex = stackIndex; // #3639
});
this.onSeries = onSeries;
}
/* eslint-enable valid-jsdoc */
};
return onSeriesMixin;
});
_registerModule(_modules, 'modules/windbarb.src.js', [_modules['parts/Globals.js'], _modules['parts/Utilities.js'], _modules['mixins/on-series.js']], function (H, U, onSeriesMixin) {
/* *
*
* Wind barb series module
*
* (c) 2010-2020 Torstein Honsi
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
var animObject = U.animObject, isNumber = U.isNumber, pick = U.pick, seriesType = U.seriesType;
var noop = H.noop;
// eslint-disable-next-line valid-jsdoc
/**
* Once off, register the windbarb approximation for data grouping. This can be
* called anywhere (not necessarily in the translate function), but must happen
* after the data grouping module is loaded and before the wind barb series uses
* it.
* @private
*/
function registerApproximation() {
if (H.approximations && !H.approximations.windbarb) {
H.approximations.windbarb = function (values, directions) {
var vectorX = 0, vectorY = 0, i, len = values.length;
for (i = 0; i < len; i++) {
vectorX += values[i] * Math.cos(directions[i] * H.deg2rad);
vectorY += values[i] * Math.sin(directions[i] * H.deg2rad);
}
return [
// Wind speed
values.reduce(function (sum, value) {
return sum + value;
}, 0) / values.length,
// Wind direction
Math.atan2(vectorY, vectorX) / H.deg2rad
];
};
}
}
registerApproximation();
/**
* @private
* @class
* @name Highcharts.seriesTypes.windbarb
*
* @augments Highcharts.Series
*/
seriesType('windbarb', 'column'
/**
* 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.
*
* @sample {highcharts|highstock} highcharts/demo/windbarb-series/
* Wind barb series
*
* @extends plotOptions.column
* @excluding boostThreshold, marker, connectEnds, connectNulls,
* cropThreshold, dashStyle, dragDrop, gapSize, gapUnit,
* linecap, shadow, stacking, step
* @since 6.0.0
* @product highcharts highstock
* @requires modules/windbarb
* @optionparent plotOptions.windbarb
*/
, {
/**
* Data grouping options for the wind barbs. In Highcharts, this
* requires the `modules/datagrouping.js` module to be loaded. In
* Highstock, data grouping is included.
*
* @sample highcharts/plotoptions/windbarb-datagrouping
* Wind barb with data grouping
*
* @since 7.1.0
* @product highcharts highstock
*/
dataGrouping: {
/**
* Whether to enable data grouping.
*
* @product highcharts highstock
*/
enabled: true,
/**
* Approximation function for the data grouping. The default
* returns an average of wind speed and a vector average direction
* weighted by wind speed.
*
* @product highcharts highstock
*
* @type {string|Function}
*/
approximation: 'windbarb',
/**
* The approximate data group width.
*
* @product highcharts highstock
*/
groupPixelWidth: 30
},
/**
* 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,
/**
* @default value
*/
colorKey: 'value',
/**
* 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'],
init: function (chart, options) {
registerApproximation();
H.Series.prototype.init.call(this, chart, options);
},
// 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;
},
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],
['L', -1.5 * u, 7 * u],
['L', 0, 10 * u],
['L', 1.5 * u, 7 * u],
['L', 0, 7 * u],
['L', 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', 0, pos * u] : ['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', 0, pos * u] : ['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', 0, pos * u] : ['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);
this.points.forEach(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;
this.points.forEach(function (point) {
var plotX = point.plotX, plotY = point.plotY;
// Check if it's inside the plot area, but only for the X
// dimension.
if (this.options.clip === false ||
chart.isInsidePlot(plotX, 0, false)) {
// Create the graphic the first time
if (!point.graphic) {
point.graphic = this.chart.renderer
.path()
.add(this.markerGroup)
.addClass('highcharts-point ' +
'highcharts-color-' +
pick(point.colorIndex, point.series.colorIndex));
}
// Position the graphic
point.graphic
.attr({
d: this.windArrow(point),
translateX: plotX + this.options.xOffset,
translateY: plotY + this.options.yOffset,
rotation: point.direction
});
if (!this.chart.styledMode) {
point.graphic
.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 initializing series.
animate: function (init) {
if (init) {
this.markerGroup.attr({
opacity: 0.01
});
}
else {
this.markerGroup.animate({
opacity: 1
}, animObject(this.options.animation));
}
},
// Don't invert the marker group (#4960)
invertGroups: noop,
// No data extremes for the Y axis
getExtremes: function () { return ({}); }
}, {
isValid: function () {
return 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).
*
* @extends series,plotOptions.windbarb
* @excluding dataParser, dataURL
* @product highcharts highstock
* @requires modules/windbarb
* @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
* }]
* ```
*
* @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
*
* @type {Array<Array<(number|string),number,number>|*>}
* @extends series.line.data
* @product highcharts highstock
* @apioption series.windbarb.data
*/
/**
* The wind speed in meters per second.
*
* @type {number|null}
* @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
*/
''; // adds doclets above to transpiled file
});
_registerModule(_modules, 'masters/modules/windbarb.src.js', [], function () {
});
}));