highstock-release/indicators/momentum.src.js

Official shim repo for Highstock releases.

/**
 * @license  Highcharts JS v6.0.1 (2017-10-05)
 *
 * Indicator series type for Highstock
 *
 * (c) 2010-2017 Sebastian Bochan
 *
 * License: www.highcharts.com/license
 */
'use strict';
(function(factory) {
    if (typeof module === 'object' && module.exports) {
        module.exports = factory;
    } else {
        factory(Highcharts);
    }
}(function(Highcharts) {
    (function(H) {

        var isArray = H.isArray,
            seriesType = H.seriesType;

        function populateAverage(points, xVal, yVal, i, period) {
            var mmY = yVal[i - 1][3] - yVal[i - period - 1][3],
                mmX = xVal[i - 1];

            points.shift(); // remove point until range < period

            return [mmX, mmY];
        }

        /**
         * The Momentum series type.
         *
         * @constructor seriesTypes.momentum
         * @augments seriesTypes.sma
         */
        seriesType('momentum', 'sma',
            /**
             * Momentum. This series requires `linkedTo` option to be set.
             * 
             * @extends {plotOptions.sma}
             * @product highstock
             * @sample {highstock} stock/indicators/momentum Exponential moving average indicator
             * @since 6.0.0
             * @optionparent plotOptions.momentum
             */
            {
                name: 'Momentum (14)',
                params: {
                    period: 14
                }
            }, {
                getValues: function(series, params) {
                    var period = params.period,
                        xVal = series.xData,
                        yVal = series.yData,
                        yValLen = yVal ? yVal.length : 0,
                        xValue = xVal[0],
                        yValue = yVal[0],
                        MM = [],
                        xData = [],
                        yData = [],
                        index,
                        i,
                        points,
                        MMPoint;

                    if (xVal.length <= period) {
                        return false;
                    }

                    // Switch index for OHLC / Candlestick / Arearange
                    if (isArray(yVal[0])) {
                        yValue = yVal[0][3];
                    } else {
                        return false;
                    }
                    // Starting point
                    points = [
                        [xValue, yValue]
                    ];


                    // Calculate value one-by-one for each perdio in visible data
                    for (i = (period + 1); i < yValLen; i++) {
                        MMPoint = populateAverage(points, xVal, yVal, i, period, index);
                        MM.push(MMPoint);
                        xData.push(MMPoint[0]);
                        yData.push(MMPoint[1]);
                    }

                    MMPoint = populateAverage(points, xVal, yVal, i, period, index);
                    MM.push(MMPoint);
                    xData.push(MMPoint[0]);
                    yData.push(MMPoint[1]);

                    return {
                        values: MM,
                        xData: xData,
                        yData: yData
                    };
                }
            });

        /**
         * A `Momentum` series. If the [type](#series.momentum.type) option is not
         * specified, it is inherited from [chart.type](#chart.type).
         * 
         * For options that apply to multiple series, it is recommended to add
         * them to the [plotOptions.series](#plotOptions.series) options structure.
         * To apply to all series of this specific type, apply it to 
         * [plotOptions.momentum](#plotOptions.momentum).
         * 
         * @type {Object}
         * @since 6.0.0
         * @extends series,plotOptions.momentum
         * @excluding data,dataParser,dataURL
         * @product highstock
         * @apioption series.momentum
         */

        /**
         * @type {Array<Object|Array>}
         * @since 6.0.0
         * @extends series.sma.data
         * @product highstock
         * @apioption series.momentum.data
         */

    }(Highcharts));
}));