highcharts
Version:
JavaScript charting framework
430 lines (386 loc) • 13.9 kB
JavaScript
/* *
*
* License: www.highcharts.com/license
*
* */
;
import H from '../parts/Globals.js';
import '../parts/Utilities.js';
import requiredIndicatorMixin from '../mixins/indicator-required.js';
var pick = H.pick,
error = H.error,
Series = H.Series,
isArray = H.isArray,
addEvent = H.addEvent,
seriesType = H.seriesType,
seriesTypes = H.seriesTypes,
ohlcProto = H.seriesTypes.ohlc.prototype,
generateMessage = requiredIndicatorMixin.generateMessage;
/**
* The parameter allows setting line series type and use OHLC indicators. Data
* in OHLC format is required.
*
* @sample {highstock} stock/indicators/use-ohlc-data
* Plot line on Y axis
*
* @type {boolean}
* @product highstock
* @apioption plotOptions.line.useOhlcData
*/
addEvent(H.Series, 'init', function (eventOptions) {
var series = this,
options = eventOptions.options;
if (
options.useOhlcData &&
options.id !== 'highcharts-navigator-series'
) {
H.extend(series, {
pointValKey: ohlcProto.pointValKey,
keys: ohlcProto.keys,
pointArrayMap: ohlcProto.pointArrayMap,
toYData: ohlcProto.toYData
});
}
});
addEvent(Series, 'afterSetOptions', function (e) {
var options = e.options,
dataGrouping = options.dataGrouping;
if (
dataGrouping &&
options.useOhlcData &&
options.id !== 'highcharts-navigator-series'
) {
dataGrouping.approximation = 'ohlc';
}
});
/**
* The SMA series type.
*
* @private
* @class
* @name Highcharts.seriesTypes.sma
*
* @augments Highcharts.Series
*/
seriesType(
'sma',
'line',
/**
* Simple moving average indicator (SMA). This series requires `linkedTo`
* option to be set.
*
* @sample stock/indicators/sma
* Simple moving average indicator
*
* @extends plotOptions.line
* @since 6.0.0
* @excluding allAreas, colorAxis, joinBy, keys, navigatorOptions,
* pointInterval, pointIntervalUnit, pointPlacement,
* pointRange, pointStart, showInNavigator, stacking,
* useOhlcData
* @product highstock
* @optionparent plotOptions.sma
*/
{
/**
* The name of the series as shown in the legend, tooltip etc. If not
* set, it will be based on a technical indicator type and default
* params.
*
* @type {string}
*/
name: undefined,
tooltip: {
/**
* Number of decimals in indicator series.
*/
valueDecimals: 4
},
/**
* The main series ID that indicator will be based on. Required for this
* indicator.
*
* @type {string}
*/
linkedTo: undefined,
/**
* Whether to compare indicator to the main series values
* or indicator values.
*
* @sample {highstock} stock/plotoptions/series-comparetomain/
* Difference between comparing SMA values to the main series
* and its own values.
*
* @type {boolean}
*/
compareToMain: false,
/**
* Paramters used in calculation of regression series' points.
*/
params: {
/**
* The point index which indicator calculations will base. For
* example using OHLC data, index=2 means the indicator will be
* calculated using Low values.
*/
index: 0,
/**
* The base period for indicator calculations. This is the number of
* data points which are taken into account for the indicator
* calculations.
*/
period: 14
}
},
/**
* @lends Highcharts.Series.prototype
*/
{
processData: function () {
var series = this,
compareToMain = series.options.compareToMain,
linkedParent = series.linkedParent;
Series.prototype.processData.apply(series, arguments);
if (linkedParent && linkedParent.compareValue && compareToMain) {
series.compareValue = linkedParent.compareValue;
}
},
bindTo: {
series: true,
eventName: 'updatedData'
},
hasDerivedData: true,
useCommonDataGrouping: true,
nameComponents: ['period'],
nameSuffixes: [], // e.g. Zig Zag uses extra '%'' in the legend name
calculateOn: 'init',
// Defines on which other indicators is this indicator based on.
requiredIndicators: [],
requireIndicators: function () {
var obj = {
allLoaded: true
};
// Check whether all required indicators are loaded, else return
// the object with missing indicator's name.
this.requiredIndicators.forEach(function (indicator) {
if (seriesTypes[indicator]) {
seriesTypes[indicator].prototype.requireIndicators();
} else {
obj.allLoaded = false;
obj.needed = indicator;
}
});
return obj;
},
init: function (chart, options) {
var indicator = this,
requiredIndicators = indicator.requireIndicators();
// Check whether all required indicators are loaded.
if (!requiredIndicators.allLoaded) {
return error(
generateMessage(indicator.type, requiredIndicators.needed)
);
}
Series.prototype.init.call(
indicator,
chart,
options
);
// Make sure we find series which is a base for an indicator
chart.linkSeries();
indicator.dataEventsToUnbind = [];
function recalculateValues() {
var oldData = indicator.points || [],
oldDataLength = (indicator.xData || []).length,
processedData = indicator.getValues(
indicator.linkedParent,
indicator.options.params
) || {
values: [],
xData: [],
yData: []
},
croppedDataValues = [],
overwriteData = true,
oldFirstPointIndex,
oldLastPointIndex,
croppedData,
min,
max,
i;
// We need to update points to reflect changes in all,
// x and y's, values. However, do it only for non-grouped
// data - grouping does it for us (#8572)
if (
oldDataLength &&
!indicator.hasGroupedData &&
indicator.visible &&
indicator.points
) {
// When data is cropped update only avaliable points (#9493)
if (indicator.cropped) {
if (indicator.xAxis) {
min = indicator.xAxis.min;
max = indicator.xAxis.max;
}
croppedData = indicator.cropData(
processedData.xData,
processedData.yData,
min,
max
);
for (i = 0; i < croppedData.xData.length; i++) {
// (#10774)
croppedDataValues.push([
croppedData.xData[i]
].concat(
H.splat(croppedData.yData[i])
));
}
oldFirstPointIndex = processedData.xData.indexOf(
indicator.xData[0]
);
oldLastPointIndex = processedData.xData.indexOf(
indicator.xData[indicator.xData.length - 1]
);
// Check if indicator points should be shifted (#8572)
if (
oldFirstPointIndex === -1 &&
oldLastPointIndex === processedData.xData.length - 2
) {
if (croppedDataValues[0][0] === oldData[0].x) {
croppedDataValues.shift();
}
}
indicator.updateData(croppedDataValues);
// Omit addPoint() and removePoint() cases
} else if (
processedData.xData.length !== oldDataLength - 1 &&
processedData.xData.length !== oldDataLength + 1
) {
overwriteData = false;
indicator.updateData(processedData.values);
}
}
if (overwriteData) {
indicator.xData = processedData.xData;
indicator.yData = processedData.yData;
indicator.options.data = processedData.values;
}
// Removal of processedXData property is required because on
// first translate processedXData array is empty
if (indicator.bindTo.series === false) {
delete indicator.processedXData;
indicator.isDirty = true;
indicator.redraw();
}
indicator.isDirtyData = false;
}
if (!indicator.linkedParent) {
return error(
'Series ' +
indicator.options.linkedTo +
' not found! Check `linkedTo`.',
false,
chart
);
}
indicator.dataEventsToUnbind.push(
addEvent(
indicator.bindTo.series ?
indicator.linkedParent : indicator.linkedParent.xAxis,
indicator.bindTo.eventName,
recalculateValues
)
);
if (indicator.calculateOn === 'init') {
recalculateValues();
} else {
var unbinder = addEvent(
indicator.chart,
indicator.calculateOn,
function () {
recalculateValues();
// Call this just once, on init
unbinder();
}
);
}
return indicator;
},
getName: function () {
var name = this.name,
params = [];
if (!name) {
(this.nameComponents || []).forEach(
function (component, index) {
params.push(
this.options.params[component] +
pick(this.nameSuffixes[index], '')
);
},
this
);
name = (this.nameBase || this.type.toUpperCase()) +
(this.nameComponents ? ' (' + params.join(', ') + ')' : '');
}
return name;
},
getValues: function (series, params) {
var period = params.period,
xVal = series.xData,
yVal = series.yData,
yValLen = yVal.length,
range = 0,
sum = 0,
SMA = [],
xData = [],
yData = [],
index = -1,
i,
SMAPoint;
if (xVal.length < period) {
return false;
}
// Switch index for OHLC / Candlestick / Arearange
if (isArray(yVal[0])) {
index = params.index ? params.index : 0;
}
// Accumulate first N-points
while (range < period - 1) {
sum += index < 0 ? yVal[range] : yVal[range][index];
range++;
}
// Calculate value one-by-one for each period in visible data
for (i = range; i < yValLen; i++) {
sum += index < 0 ? yVal[i] : yVal[i][index];
SMAPoint = [xVal[i], sum / period];
SMA.push(SMAPoint);
xData.push(SMAPoint[0]);
yData.push(SMAPoint[1]);
sum -= index < 0 ? yVal[i - range] : yVal[i - range][index];
}
return {
values: SMA,
xData: xData,
yData: yData
};
},
destroy: function () {
this.dataEventsToUnbind.forEach(function (unbinder) {
unbinder();
});
Series.prototype.destroy.call(this);
}
}
);
/**
* A `SMA` series. If the [type](#series.sma.type) option is not specified, it
* is inherited from [chart.type](#chart.type).
*
* @extends series,plotOptions.sma
* @since 6.0.0
* @product highstock
* @excluding dataParser, dataURL, useOhlcData
* @apioption series.sma
*/