240 lines
8.3 KiB
JavaScript
240 lines
8.3 KiB
JavaScript
|
/* *
|
||
|
|
*
|
||
|
|
* (c) 2010-2020 Torstein Honsi
|
||
|
|
*
|
||
|
|
* License: www.highcharts.com/license
|
||
|
|
*
|
||
|
|
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
|
||
|
|
*
|
||
|
|
* */
|
||
|
|
'use strict';
|
||
|
|
import H from '../parts/Globals.js';
|
||
|
|
import U from '../parts/Utilities.js';
|
||
|
|
var clamp = U.clamp, merge = U.merge, pick = U.pick, seriesType = U.seriesType;
|
||
|
|
var defaultPlotOptions = H.defaultPlotOptions, noop = H.noop, seriesTypes = H.seriesTypes;
|
||
|
|
var colProto = seriesTypes.column.prototype;
|
||
|
|
/**
|
||
|
|
* The column range is a cartesian series type with higher and lower
|
||
|
|
* Y values along an X axis. To display horizontal bars, set
|
||
|
|
* [chart.inverted](#chart.inverted) to `true`.
|
||
|
|
*
|
||
|
|
* @sample {highcharts|highstock} highcharts/demo/columnrange/
|
||
|
|
* Inverted column range
|
||
|
|
*
|
||
|
|
* @extends plotOptions.column
|
||
|
|
* @since 2.3.0
|
||
|
|
* @excluding negativeColor, stacking, softThreshold, threshold
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @requires highcharts-more
|
||
|
|
* @optionparent plotOptions.columnrange
|
||
|
|
*/
|
||
|
|
var columnRangeOptions = {
|
||
|
|
/**
|
||
|
|
* Extended data labels for range series types. Range series data labels
|
||
|
|
* have no `x` and `y` options. Instead, they have `xLow`, `xHigh`,
|
||
|
|
* `yLow` and `yHigh` options to allow the higher and lower data label
|
||
|
|
* sets individually.
|
||
|
|
*
|
||
|
|
* @declare Highcharts.SeriesAreaRangeDataLabelsOptionsObject
|
||
|
|
* @extends plotOptions.arearange.dataLabels
|
||
|
|
* @since 2.3.0
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @apioption plotOptions.columnrange.dataLabels
|
||
|
|
*/
|
||
|
|
pointRange: null,
|
||
|
|
/** @ignore-option */
|
||
|
|
marker: null,
|
||
|
|
states: {
|
||
|
|
hover: {
|
||
|
|
/** @ignore-option */
|
||
|
|
halo: false
|
||
|
|
}
|
||
|
|
}
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* The ColumnRangeSeries class
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
* @class
|
||
|
|
* @name Highcharts.seriesTypes.columnrange
|
||
|
|
*
|
||
|
|
* @augments Highcharts.Series
|
||
|
|
*/
|
||
|
|
seriesType('columnrange', 'arearange', merge(defaultPlotOptions.column, defaultPlotOptions.arearange, columnRangeOptions), {
|
||
|
|
// eslint-disable-next-line valid-jsdoc
|
||
|
|
/**
|
||
|
|
* Translate data points from raw values x and y to plotX and plotY
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
translate: function () {
|
||
|
|
var series = this, yAxis = series.yAxis, xAxis = series.xAxis, startAngleRad = xAxis.startAngleRad, start, chart = series.chart, isRadial = series.xAxis.isRadial, safeDistance = Math.max(chart.chartWidth, chart.chartHeight) + 999, plotHigh;
|
||
|
|
// eslint-disable-next-line valid-jsdoc
|
||
|
|
/**
|
||
|
|
* Don't draw too far outside plot area (#6835)
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
function safeBounds(pixelPos) {
|
||
|
|
return clamp(pixelPos, -safeDistance, safeDistance);
|
||
|
|
}
|
||
|
|
colProto.translate.apply(series);
|
||
|
|
// Set plotLow and plotHigh
|
||
|
|
series.points.forEach(function (point) {
|
||
|
|
var shapeArgs = point.shapeArgs, minPointLength = series.options.minPointLength, heightDifference, height, y;
|
||
|
|
point.plotHigh = plotHigh = safeBounds(yAxis.translate(point.high, 0, 1, 0, 1));
|
||
|
|
point.plotLow = safeBounds(point.plotY);
|
||
|
|
// adjust shape
|
||
|
|
y = plotHigh;
|
||
|
|
height = pick(point.rectPlotY, point.plotY) - plotHigh;
|
||
|
|
// Adjust for minPointLength
|
||
|
|
if (Math.abs(height) < minPointLength) {
|
||
|
|
heightDifference = (minPointLength - height);
|
||
|
|
height += heightDifference;
|
||
|
|
y -= heightDifference / 2;
|
||
|
|
// Adjust for negative ranges or reversed Y axis (#1457)
|
||
|
|
}
|
||
|
|
else if (height < 0) {
|
||
|
|
height *= -1;
|
||
|
|
y -= height;
|
||
|
|
}
|
||
|
|
if (isRadial) {
|
||
|
|
start = point.barX + startAngleRad;
|
||
|
|
point.shapeType = 'arc';
|
||
|
|
point.shapeArgs = series.polarArc(y + height, y, start, start + point.pointWidth);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
shapeArgs.height = height;
|
||
|
|
shapeArgs.y = y;
|
||
|
|
point.tooltipPos = chart.inverted ?
|
||
|
|
[
|
||
|
|
yAxis.len + yAxis.pos - chart.plotLeft - y -
|
||
|
|
height / 2,
|
||
|
|
xAxis.len + xAxis.pos - chart.plotTop -
|
||
|
|
shapeArgs.x - shapeArgs.width / 2,
|
||
|
|
height
|
||
|
|
] : [
|
||
|
|
xAxis.left - chart.plotLeft + shapeArgs.x +
|
||
|
|
shapeArgs.width / 2,
|
||
|
|
yAxis.pos - chart.plotTop + y + height / 2,
|
||
|
|
height
|
||
|
|
]; // don't inherit from column tooltip position - #3372
|
||
|
|
}
|
||
|
|
});
|
||
|
|
},
|
||
|
|
directTouch: true,
|
||
|
|
trackerGroups: ['group', 'dataLabelsGroup'],
|
||
|
|
drawGraph: noop,
|
||
|
|
getSymbol: noop,
|
||
|
|
// Overrides from modules that may be loaded after this module
|
||
|
|
crispCol: function () {
|
||
|
|
return colProto.crispCol.apply(this, arguments);
|
||
|
|
},
|
||
|
|
drawPoints: function () {
|
||
|
|
return colProto.drawPoints.apply(this, arguments);
|
||
|
|
},
|
||
|
|
drawTracker: function () {
|
||
|
|
return colProto.drawTracker.apply(this, arguments);
|
||
|
|
},
|
||
|
|
getColumnMetrics: function () {
|
||
|
|
return colProto.getColumnMetrics.apply(this, arguments);
|
||
|
|
},
|
||
|
|
pointAttribs: function () {
|
||
|
|
return colProto.pointAttribs.apply(this, arguments);
|
||
|
|
},
|
||
|
|
animate: function () {
|
||
|
|
return colProto.animate.apply(this, arguments);
|
||
|
|
},
|
||
|
|
polarArc: function () {
|
||
|
|
return colProto.polarArc.apply(this, arguments);
|
||
|
|
},
|
||
|
|
translate3dPoints: function () {
|
||
|
|
return colProto.translate3dPoints.apply(this, arguments);
|
||
|
|
},
|
||
|
|
translate3dShapes: function () {
|
||
|
|
return colProto.translate3dShapes.apply(this, arguments);
|
||
|
|
}
|
||
|
|
}, {
|
||
|
|
setState: colProto.pointClass.prototype.setState
|
||
|
|
});
|
||
|
|
/**
|
||
|
|
* A `columnrange` series. If the [type](#series.columnrange.type)
|
||
|
|
* option is not specified, it is inherited from
|
||
|
|
* [chart.type](#chart.type).
|
||
|
|
*
|
||
|
|
* @extends series,plotOptions.columnrange
|
||
|
|
* @excluding dataParser, dataURL, stack, stacking
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @requires highcharts-more
|
||
|
|
* @apioption series.columnrange
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* An array of data points for the series. For the `columnrange` series
|
||
|
|
* type, points can be given in the following ways:
|
||
|
|
*
|
||
|
|
* 1. An array of arrays with 3 or 2 values. In this case, the values correspond
|
||
|
|
* to `x,low,high`. If the first value is a string, it is applied as the name
|
||
|
|
* of the point, and the `x` value is inferred. The `x` value can also be
|
||
|
|
* omitted, in which case the inner arrays should be of length 2\. Then the
|
||
|
|
* `x` value is automatically calculated, either starting at 0 and
|
||
|
|
* incremented by 1, or from `pointStart` and `pointInterval` given in the
|
||
|
|
* series options.
|
||
|
|
* ```js
|
||
|
|
* data: [
|
||
|
|
* [0, 4, 2],
|
||
|
|
* [1, 2, 1],
|
||
|
|
* [2, 9, 10]
|
||
|
|
* ]
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* 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.columnrange.turboThreshold), this option is not
|
||
|
|
* available.
|
||
|
|
* ```js
|
||
|
|
* data: [{
|
||
|
|
* x: 1,
|
||
|
|
* low: 0,
|
||
|
|
* high: 4,
|
||
|
|
* name: "Point2",
|
||
|
|
* color: "#00FF00"
|
||
|
|
* }, {
|
||
|
|
* x: 1,
|
||
|
|
* low: 5,
|
||
|
|
* high: 3,
|
||
|
|
* name: "Point1",
|
||
|
|
* color: "#FF00FF"
|
||
|
|
* }]
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @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>|Array<(number|string),number,number>|*>}
|
||
|
|
* @extends series.arearange.data
|
||
|
|
* @excluding marker
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @apioption series.columnrange.data
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @extends series.columnrange.dataLabels
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @apioption series.columnrange.data.dataLabels
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @excluding halo, lineWidth, lineWidthPlus, marker
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @apioption series.columnrange.states.hover
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @excluding halo, lineWidth, lineWidthPlus, marker
|
||
|
|
* @product highcharts highstock
|
||
|
|
* @apioption series.columnrange.states.select
|
||
|
|
*/
|
||
|
|
''; // adds doclets above into transpiled
|