indicators.src.js 20.1 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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
/**
 * @license Highstock JS v7.2.0 (2019-09-03)
 *
 * Indicator series type for Highstock
 *
 * (c) 2010-2019 Pawel Fus, Sebastian Bochan
 *
 * License: www.highcharts.com/license
 */
'use strict';
(function (factory) {
    if (typeof module === 'object' && module.exports) {
        factory['default'] = factory;
        module.exports = factory;
    } else if (typeof define === 'function' && define.amd) {
        define('highcharts/indicators/indicators', ['highcharts', 'highcharts/modules/stock'], function (Highcharts) {
            factory(Highcharts);
            factory.Highcharts = Highcharts;
            return factory;
        });
    } else {
        factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
    }
}(function (Highcharts) {
    var _modules = Highcharts ? Highcharts._modules : {};
    function _registerModule(obj, path, args, fn) {
        if (!obj.hasOwnProperty(path)) {
            obj[path] = fn.apply(null, args);
        }
    }
    _registerModule(_modules, 'mixins/indicator-required.js', [_modules['parts/Globals.js']], function (H) {
        /**
         *
         *  (c) 2010-2019 Daniel Studencki
         *
         *  License: www.highcharts.com/license
         *
         *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
         *
         * */
        var error = H.error;
        /* eslint-disable no-invalid-this, valid-jsdoc */
        var requiredIndicatorMixin = {
            /**
             * Check whether given indicator is loaded, else throw error.
             * @private
             * @param {Highcharts.Indicator} indicator
             *        Indicator constructor function.
             * @param {string} requiredIndicator
             *        Required indicator type.
             * @param {string} type
             *        Type of indicator where function was called (parent).
             * @param {Highcharts.IndicatorConstructorFunction} callback
             *        Callback which is triggered if the given indicator is loaded.
             *        Takes indicator as an argument.
             * @param {string} errMessage
             *        Error message that will be logged in console.
             * @return {boolean}
             *         Returns false when there is no required indicator loaded.
             */
            isParentLoaded: function (indicator, requiredIndicator, type, callback, errMessage) {
                if (indicator) {
                    return callback ? callback(indicator) : true;
                }
                error(errMessage || this.generateMessage(type, requiredIndicator));
                return false;
            },
            /**
             * @private
             * @param {string} indicatorType
             *        Indicator type
             * @param {string} required
             *        Required indicator
             * @return {string}
             *         Error message
             */
            generateMessage: function (indicatorType, required) {
                return 'Error: "' + indicatorType +
                    '" indicator type requires "' + required +
                    '" indicator loaded before. Please read docs: ' +
                    'https://api.highcharts.com/highstock/plotOptions.' +
                    indicatorType;
            }
        };

        return requiredIndicatorMixin;
    });
    _registerModule(_modules, 'indicators/indicators.src.js', [_modules['parts/Globals.js'], _modules['parts/Utilities.js'], _modules['mixins/indicator-required.js']], function (H, U, requiredIndicatorMixin) {
        /* *
         *
         *  License: www.highcharts.com/license
         *
         * */



        var isArray = U.isArray,
            splat = U.splat;


        var pick = H.pick,
            error = H.error,
            Series = H.Series,
            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, dragDrop, 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(
                                        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
         */

    });
    _registerModule(_modules, 'masters/indicators/indicators.src.js', [], function () {


    });
}));