/* *
 *
 *  License: www.highcharts.com/license
 *
 * */

'use strict';

import H from '../parts/Globals.js';
import '../parts/Utilities.js';
import multipleLinesMixin from '../mixins/multipe-lines.js';

var SMA = H.seriesTypes.sma,
    EMA = H.seriesTypes.ema,
    ATR = H.seriesTypes.atr,
    merge = H.merge,
    correctFloat = H.correctFloat;

/**
 * The Keltner Channels series type.
 *
 * @private
 * @class
 * @name Highcharts.seriesTypes.keltnerchannels
 *
 * @augments Highcharts.Series
 */
H.seriesType(
    'keltnerchannels',
    'sma',
    /**
     * Keltner Channels. This series requires the `linkedTo` option to be set
     * and should be loaded after the `stock/indicators/indicators.js`,
     * `stock/indicators/atr.js`, and `stock/ema/.js`.
     *
     * @sample {highstock} stock/indicators/keltner-channels
     *         Keltner Channels
     *
     * @extends      plotOptions.sma
     * @since        7.0.0
     * @product      highstock
     * @excluding    allAreas, colorAxis, compare, compareBase, joinBy, keys,
     *               navigatorOptions, pointInterval, pointIntervalUnit,
     *               pointPlacement, pointRange, pointStart,showInNavigator,
     *               stacking
     * @optionparent plotOptions.keltnerchannels
     */
    {
        params: {
            period: 20,
            /**
             * The ATR period.
             */
            periodATR: 10,
            /**
             * The ATR multiplier.
             */
            multiplierATR: 2
        },
        /**
         * Bottom line options.
         *
         */
        bottomLine: {
            /**
             * Styles for a bottom line.
             *
             */
            styles: {
                /**
                 * Pixel width of the line.
                 */
                lineWidth: 1,
                /**
                 * Color of the line. If not set, it's inherited from
                 * `plotOptions.keltnerchannels.color`
                 */
                lineColor: undefined
            }
        },
        /**
         * Top line options.
         *
         * @extends plotOptions.keltnerchannels.bottomLine
         */
        topLine: {
            styles: {
                lineWidth: 1,
                lineColor: undefined
            }
        },
        tooltip: {
            pointFormat: '<span style="color:{point.color}">\u25CF</span><b> {series.name}</b><br/>Upper Channel: {point.top}<br/>EMA({series.options.params.period}): {point.middle}<br/>Lower Channel: {point.bottom}<br/>'
        },
        marker: {
            enabled: false
        },
        dataGrouping: {
            approximation: 'averages'
        },
        lineWidth: 1
    },
    /**
     * @lends Highcharts.Series#
     */
    merge(multipleLinesMixin, {
        pointArrayMap: ['top', 'middle', 'bottom'],
        pointValKey: 'middle',
        nameBase: 'Keltner Channels',
        nameComponents: ['period', 'periodATR', 'multiplierATR'],
        linesApiNames: ['topLine', 'bottomLine'],
        requiredIndicators: ['ema', 'atr'],
        init: function () {
            SMA.prototype.init.apply(this, arguments);
            // Set default color for lines:
            this.options = merge({
                topLine: {
                    styles: {
                        lineColor: this.color
                    }
                },
                bottomLine: {
                    styles: {
                        lineColor: this.color
                    }
                }
            }, this.options);
        },
        getValues: function (series, params) {
            var period = params.period,
                periodATR = params.periodATR,
                multiplierATR = params.multiplierATR,
                index = params.index,
                yVal = series.yData,
                yValLen = yVal ? yVal.length : 0,
                // Keltner Channels array structure:
                // 0-date, 1-top line, 2-middle line, 3-bottom line
                KC = [],
                ML, TL, BL, // middle line, top line and bottom line
                date,
                seriesEMA = EMA.prototype.getValues(series,
                    {
                        period: period,
                        index: index
                    }),
                seriesATR = ATR.prototype.getValues(series,
                    {
                        period: periodATR
                    }),
                pointEMA,
                pointATR,
                xData = [],
                yData = [],
                i;

            if (yValLen < period) {
                return false;
            }

            for (i = period; i <= yValLen; i++) {
                pointEMA = seriesEMA.values[i - period];
                pointATR = seriesATR.values[i - periodATR];
                date = pointEMA[0];
                TL = correctFloat(pointEMA[1] + (multiplierATR * pointATR[1]));
                BL = correctFloat(pointEMA[1] - (multiplierATR * pointATR[1]));
                ML = pointEMA[1];
                KC.push([date, TL, ML, BL]);
                xData.push(date);
                yData.push([TL, ML, BL]);
            }

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

/**
 * A Keltner Channels indicator. If the [type](#series.keltnerchannels.type)
 * option is not specified, it is inherited from[chart.type](#chart.type).
 *
 * @extends      series,plotOptions.keltnerchannels
 * @since        7.0.0
 * @product      highstock
 * @excluding    allAreas, colorAxis, compare, compareBase, dataParser, dataURL,
 *               joinBy, keys, navigatorOptions, pointInterval,
 *               pointIntervalUnit, pointPlacement, pointRange, pointStart,
 *               stacking, showInNavigator
 * @optionparent series.keltnerchannels
 */