UNPKG

highcharts

Version:
124 lines (123 loc) 2.99 kB
/* * * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ 'use strict'; import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js'; const { sma: SMAIndicator } = SeriesRegistry.seriesTypes; import U from '../../../Core/Utilities.js'; const { extend, isArray, merge } = U; /* * * * Functions * * */ /** * @private */ function populateAverage(xVal, yVal, i, period, index) { const mmY = yVal[i - 1][index] - yVal[i - period - 1][index], mmX = xVal[i - 1]; return [mmX, mmY]; } /* * * * Class * * */ /** * The Momentum series type. * * @private * @class * @name Highcharts.seriesTypes.momentum * * @augments Highcharts.Series */ class MomentumIndicator extends SMAIndicator { /* * * * Functions * * */ getValues(series, params) { const period = params.period, index = params.index, xVal = series.xData, yVal = series.yData, yValLen = yVal ? yVal.length : 0, MM = [], xData = [], yData = []; let i, MMPoint; if (xVal.length <= period) { return; } // Switch index for OHLC / Candlestick / Arearange if (!isArray(yVal[0])) { return; } // Calculate value one-by-one for each period in visible data for (i = (period + 1); i < yValLen; i++) { MMPoint = populateAverage(xVal, yVal, i, period, index); MM.push(MMPoint); xData.push(MMPoint[0]); yData.push(MMPoint[1]); } MMPoint = populateAverage(xVal, yVal, i, period, index); MM.push(MMPoint); xData.push(MMPoint[0]); yData.push(MMPoint[1]); return { values: MM, xData: xData, yData: yData }; } } /* * * * Static Properties * * */ /** * Momentum. This series requires `linkedTo` option to be set. * * @sample stock/indicators/momentum * Momentum indicator * * @extends plotOptions.sma * @since 6.0.0 * @product highstock * @requires stock/indicators/indicators * @requires stock/indicators/momentum * @optionparent plotOptions.momentum */ MomentumIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, { params: { index: 3 } }); extend(MomentumIndicator.prototype, { nameBase: 'Momentum' }); SeriesRegistry.registerSeriesType('momentum', MomentumIndicator); /* * * * Default Export * * */ export default MomentumIndicator; /* * * * API Options * * */ /** * A `Momentum` series. If the [type](#series.momentum.type) option is not * specified, it is inherited from [chart.type](#chart.type). * * @extends series,plotOptions.momentum * @since 6.0.0 * @excluding dataParser, dataURL * @product highstock * @requires stock/indicators/indicators * @requires stock/indicators/momentum * @apioption series.momentum */ ''; // To include the above in the js output