ErrorBarSeries.js
4.93 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
/**
* (c) 2010-2018 Torstein Honsi
*
* License: www.highcharts.com/license
*/
'use strict';
import H from '../parts/Globals.js';
import '../parts/Utilities.js';
import '../parts/Options.js';
import './BoxPlotSeries.js';
var each = H.each,
noop = H.noop,
seriesType = H.seriesType,
seriesTypes = H.seriesTypes;
/**
* Error bars are a graphical representation of the variability of data and are
* used on graphs to indicate the error, or uncertainty in a reported
* measurement.
*
* @sample highcharts/demo/error-bar/
* Error bars on a column series
* @sample highcharts/series-errorbar/on-scatter/
* Error bars on a scatter series
* @extends {plotOptions.boxplot}
* @product highcharts highstock
* @optionparent plotOptions.errorbar
*/
seriesType('errorbar', 'boxplot', {
grouping: false,
/**
* The parent series of the error bar. The default value links it to
* the previous series. Otherwise, use the id of the parent series.
*
* @since 3.0
* @product highcharts
*/
linkedTo: ':previous',
tooltip: {
pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>'
},
/**
* The line width of the whiskers, the horizontal lines marking low
* and high values. When `null`, the general
* [lineWidth](#plotOptions.errorbar.lineWidth) applies.
*
* @type {Number}
* @sample {highcharts} highcharts/plotoptions/error-bar-styling/
* Error bar styling
* @since 3.0
* @product highcharts
*/
whiskerWidth: null
// Prototype members
}, {
type: 'errorbar',
pointArrayMap: ['low', 'high'], // array point configs are mapped to this
toYData: function (point) { // return a plain array for speedy calculation
return [point.low, point.high];
},
pointValKey: 'high', // defines the top of the tracker
doQuartiles: false,
drawDataLabels: seriesTypes.arearange ?
function () {
var valKey = this.pointValKey;
seriesTypes.arearange.prototype.drawDataLabels.call(this);
// Arearange drawDataLabels does not reset point.y to high,
// but to low after drawing (#4133)
each(this.data, function (point) {
point.y = point[valKey];
});
} :
noop,
/**
* Get the width and X offset, either on top of the linked series column
* or standalone
*/
getColumnMetrics: function () {
return (this.linkedParent && this.linkedParent.columnMetrics) ||
seriesTypes.column.prototype.getColumnMetrics.call(this);
}
});
/**
* A `errorbar` series. If the [type](#series.errorbar.type) option
* is not specified, it is inherited from [chart.type](#chart.type).
*
* @type {Object}
* @extends series,plotOptions.errorbar
* @excluding dataParser,dataURL,stack,stacking
* @product highcharts
* @apioption series.errorbar
*/
/**
* An array of data points for the series. For the `errorbar` 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, 10, 2],
* [1, 1, 8],
* [2, 4, 5]
* ]
* ```
*
* 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.errorbar.turboThreshold),
* this option is not available.
*
* ```js
* data: [{
* x: 1,
* low: 0,
* high: 0,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* low: 5,
* high: 5,
* name: "Point1",
* color: "#FF00FF"
* }]
* ```
*
* @type {Array<Object|Array>}
* @extends series.arearange.data
* @excluding dataLabels,drilldown,marker,states
* @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
* @apioption series.errorbar.data
*/