123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590 |
- /**
- * @license Highcharts Stock JS v9.1.1 (2021-06-04)
- *
- * Indicator series type for Highcharts Stock
- *
- * (c) 2010-2021 Karol Kolodziej
- *
- * 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/klinger', ['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/IndicatorRequired.js', [_modules['Core/Utilities.js']], function (U) {
- /**
- *
- * (c) 2010-2021 Daniel Studencki
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var error = U.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.IndicatorCallbackFunction} 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, 'Mixins/MultipleLines.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) {
- /**
- *
- * (c) 2010-2021 Wojciech Chmiel
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var defined = U.defined,
- error = U.error,
- merge = U.merge;
- var SMA = H.seriesTypes.sma;
- /**
- * Mixin useful for all indicators that have more than one line.
- * Merge it with your implementation where you will provide
- * getValues method appropriate to your indicator and pointArrayMap,
- * pointValKey, linesApiNames properites. Notice that pointArrayMap
- * should be consistent with amount of lines calculated in getValues method.
- *
- * @private
- * @mixin multipleLinesMixin
- */
- var multipleLinesMixin = {
- /* eslint-disable valid-jsdoc */
- /**
- * Lines ids. Required to plot appropriate amount of lines.
- * Notice that pointArrayMap should have more elements than
- * linesApiNames, because it contains main line and additional lines ids.
- * Also it should be consistent with amount of lines calculated in
- * getValues method from your implementation.
- *
- * @private
- * @name multipleLinesMixin.pointArrayMap
- * @type {Array<string>}
- */
- pointArrayMap: ['top', 'bottom'],
- /**
- * Main line id.
- *
- * @private
- * @name multipleLinesMixin.pointValKey
- * @type {string}
- */
- pointValKey: 'top',
- /**
- * Additional lines DOCS names. Elements of linesApiNames array should
- * be consistent with DOCS line names defined in your implementation.
- * Notice that linesApiNames should have decreased amount of elements
- * relative to pointArrayMap (without pointValKey).
- *
- * @private
- * @name multipleLinesMixin.linesApiNames
- * @type {Array<string>}
- */
- linesApiNames: ['bottomLine'],
- /**
- * Create translatedLines Collection based on pointArrayMap.
- *
- * @private
- * @function multipleLinesMixin.getTranslatedLinesNames
- * @param {string} [excludedValue]
- * Main line id
- * @return {Array<string>}
- * Returns translated lines names without excluded value.
- */
- getTranslatedLinesNames: function (excludedValue) {
- var translatedLines = [];
- (this.pointArrayMap || []).forEach(function (propertyName) {
- if (propertyName !== excludedValue) {
- translatedLines.push('plot' +
- propertyName.charAt(0).toUpperCase() +
- propertyName.slice(1));
- }
- });
- return translatedLines;
- },
- /**
- * @private
- * @function multipleLinesMixin.toYData
- * @param {Highcharts.Point} point
- * Indicator point
- * @return {Array<number>}
- * Returns point Y value for all lines
- */
- toYData: function (point) {
- var pointColl = [];
- (this.pointArrayMap || []).forEach(function (propertyName) {
- pointColl.push(point[propertyName]);
- });
- return pointColl;
- },
- /**
- * Add lines plot pixel values.
- *
- * @private
- * @function multipleLinesMixin.translate
- * @return {void}
- */
- translate: function () {
- var indicator = this,
- pointArrayMap = indicator.pointArrayMap,
- LinesNames = [],
- value;
- LinesNames = indicator.getTranslatedLinesNames();
- SMA.prototype.translate.apply(indicator, arguments);
- indicator.points.forEach(function (point) {
- pointArrayMap.forEach(function (propertyName, i) {
- value = point[propertyName];
- if (value !== null) {
- point[LinesNames[i]] = indicator.yAxis.toPixels(value, true);
- }
- });
- });
- },
- /**
- * Draw main and additional lines.
- *
- * @private
- * @function multipleLinesMixin.drawGraph
- * @return {void}
- */
- drawGraph: function () {
- var indicator = this,
- pointValKey = indicator.pointValKey,
- linesApiNames = indicator.linesApiNames,
- mainLinePoints = indicator.points,
- pointsLength = mainLinePoints.length,
- mainLineOptions = indicator.options,
- mainLinePath = indicator.graph,
- gappedExtend = {
- options: {
- gapSize: mainLineOptions.gapSize
- }
- },
- // additional lines point place holders:
- secondaryLines = [],
- secondaryLinesNames = indicator.getTranslatedLinesNames(pointValKey),
- point;
- // Generate points for additional lines:
- secondaryLinesNames.forEach(function (plotLine, index) {
- // create additional lines point place holders
- secondaryLines[index] = [];
- while (pointsLength--) {
- point = mainLinePoints[pointsLength];
- secondaryLines[index].push({
- x: point.x,
- plotX: point.plotX,
- plotY: point[plotLine],
- isNull: !defined(point[plotLine])
- });
- }
- pointsLength = mainLinePoints.length;
- });
- // Modify options and generate additional lines:
- linesApiNames.forEach(function (lineName, i) {
- if (secondaryLines[i]) {
- indicator.points = secondaryLines[i];
- if (mainLineOptions[lineName]) {
- indicator.options = merge(mainLineOptions[lineName].styles, gappedExtend);
- }
- else {
- error('Error: "There is no ' + lineName +
- ' in DOCS options declared. Check if linesApiNames' +
- ' are consistent with your DOCS line names."' +
- ' at mixin/multiple-line.js:34');
- }
- indicator.graph = indicator['graph' + lineName];
- SMA.prototype.drawGraph.call(indicator);
- // Now save lines:
- indicator['graph' + lineName] = indicator.graph;
- }
- else {
- error('Error: "' + lineName + ' doesn\'t have equivalent ' +
- 'in pointArrayMap. To many elements in linesApiNames ' +
- 'relative to pointArrayMap."');
- }
- });
- // Restore options and draw a main line:
- indicator.points = mainLinePoints;
- indicator.options = mainLineOptions;
- indicator.graph = mainLinePath;
- SMA.prototype.drawGraph.call(indicator);
- }
- };
- return multipleLinesMixin;
- });
- _registerModule(_modules, 'Stock/Indicators/Klinger/KlingerIndicator.js', [_modules['Mixins/IndicatorRequired.js'], _modules['Mixins/MultipleLines.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (RequiredIndicatorMixin, MultipleLinesMixin, SeriesRegistry, U) {
- /* *
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var __extends = (this && this.__extends) || (function () {
- var extendStatics = function (d,
- b) {
- extendStatics = Object.setPrototypeOf ||
- ({ __proto__: [] } instanceof Array && function (d,
- b) { d.__proto__ = b; }) ||
- function (d,
- b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
- return extendStatics(d, b);
- };
- return function (d, b) {
- extendStatics(d, b);
- function __() { this.constructor = d; }
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
- };
- })();
- var _a = SeriesRegistry.seriesTypes,
- SMAIndicator = _a.sma,
- EMAIndicator = _a.ema;
- var correctFloat = U.correctFloat,
- error = U.error,
- extend = U.extend,
- isArray = U.isArray,
- merge = U.merge;
- /**
- * The Klinger oscillator series type.
- *
- * @private
- * @class
- * @name Highcharts.seriesTypes.klinger
- *
- * @augments Highcharts.Series
- */
- var KlingerIndicator = /** @class */ (function (_super) {
- __extends(KlingerIndicator, _super);
- function KlingerIndicator() {
- var _this = _super !== null && _super.apply(this,
- arguments) || this;
- /* *
- *
- * Properties
- *
- * */
- _this.data = void 0;
- _this.points = void 0;
- _this.options = void 0;
- _this.volumeSeries = void 0;
- return _this;
- }
- /* *
- *
- * Functions
- *
- * */
- KlingerIndicator.prototype.init = function () {
- var args = arguments,
- ctx = this;
- // Check if the EMA module is added.
- RequiredIndicatorMixin.isParentLoaded(EMAIndicator, 'ema', ctx.type, function (indicator) {
- indicator.prototype.init.apply(ctx, args);
- return;
- });
- };
- KlingerIndicator.prototype.calculateTrend = function (yVal, i) {
- var isUpward = yVal[i][1] + yVal[i][2] + yVal[i][3] >
- yVal[i - 1][1] + yVal[i - 1][2] + yVal[i - 1][3];
- return isUpward ? 1 : -1;
- };
- // Checks if the series and volumeSeries are accessible, number of
- // points.x is longer than period, is series has OHLC data
- KlingerIndicator.prototype.isValidData = function (firstYVal) {
- var chart = this.chart,
- options = this.options,
- series = this.linkedParent,
- isSeriesOHLC = isArray(firstYVal) &&
- firstYVal.length === 4,
- volumeSeries = this.volumeSeries ||
- (this.volumeSeries =
- chart.get(options.params.volumeSeriesID));
- if (!volumeSeries) {
- error('Series ' +
- options.params.volumeSeriesID +
- ' not found! Check `volumeSeriesID`.', true, series.chart);
- }
- var isLengthValid = [series,
- volumeSeries].every(function (series) {
- return series && series.xData && series.xData.length >=
- options.params.slowAvgPeriod;
- });
- return !!(isLengthValid && isSeriesOHLC);
- };
- KlingerIndicator.prototype.getCM = function (previousCM, DM, trend, previousTrend, prevoiusDM) {
- return correctFloat(DM + (trend === previousTrend ? previousCM : prevoiusDM));
- };
- KlingerIndicator.prototype.getDM = function (high, low) {
- return correctFloat(high - low);
- };
- KlingerIndicator.prototype.getVolumeForce = function (yVal) {
- var volumeForce = [];
- var CM = 0, // cumulative measurement
- DM, // daily measurement
- force,
- i = 1, // start from second point
- previousCM = 0,
- previousDM = yVal[0][1] - yVal[0][2], // initial DM
- previousTrend = 0,
- trend;
- for (i; i < yVal.length; i++) {
- trend = this.calculateTrend(yVal, i);
- DM = this.getDM(yVal[i][1], yVal[i][2]);
- // For the first iteration when the previousTrend doesn't exist,
- // previousCM doesn't exist either, but it doesn't matter becouse
- // it's filltered out in the getCM method in else statement,
- // (in this iteration, previousCM can be raplaced with the DM).
- CM = this.getCM(previousCM, DM, trend, previousTrend, previousDM);
- force = this.volumeSeries.yData[i] *
- trend * Math.abs(2 * ((DM / CM) - 1)) * 100;
- volumeForce.push([force]);
- // Before next iteration, assign the current as the previous.
- previousTrend = trend;
- previousCM = CM;
- previousDM = DM;
- }
- return volumeForce;
- };
- KlingerIndicator.prototype.getEMA = function (yVal, prevEMA, SMA, EMApercent, index, i, xVal) {
- return EMAIndicator.prototype.calculateEma(xVal || [], yVal, typeof i === 'undefined' ? 1 : i, EMApercent, prevEMA, typeof index === 'undefined' ? -1 : index, SMA);
- };
- KlingerIndicator.prototype.getSMA = function (period, index, values) {
- return EMAIndicator.prototype
- .accumulatePeriodPoints(period, index, values) / period;
- };
- KlingerIndicator.prototype.getValues = function (series, params) {
- var Klinger = [],
- xVal = series.xData,
- yVal = series.yData,
- xData = [],
- yData = [],
- calcSingal = [];
- var KO,
- i = 0,
- fastEMA = 0,
- slowEMA,
- // signalEMA: number|undefined = void 0,
- previousFastEMA = void 0,
- previousSlowEMA = void 0,
- signal = null;
- // If the necessary conditions are not fulfilled, don't proceed.
- if (!this.isValidData(yVal[0])) {
- return;
- }
- // Calculate the Volume Force array.
- var volumeForce = this.getVolumeForce(yVal);
- // Calculate SMA for the first points.
- var SMAFast = this.getSMA(params.fastAvgPeriod, 0,
- volumeForce),
- SMASlow = this.getSMA(params.slowAvgPeriod, 0,
- volumeForce);
- // Calculate EMApercent for the first points.
- var fastEMApercent = 2 / (params.fastAvgPeriod + 1),
- slowEMApercent = 2 / (params.slowAvgPeriod + 1);
- // Calculate KO
- for (i; i < yVal.length; i++) {
- // Get EMA for fast period.
- if (i >= params.fastAvgPeriod) {
- fastEMA = this.getEMA(volumeForce, previousFastEMA, SMAFast, fastEMApercent, 0, i, xVal)[1];
- previousFastEMA = fastEMA;
- }
- // Get EMA for slow period.
- if (i >= params.slowAvgPeriod) {
- slowEMA = this.getEMA(volumeForce, previousSlowEMA, SMASlow, slowEMApercent, 0, i, xVal)[1];
- previousSlowEMA = slowEMA;
- KO = correctFloat(fastEMA - slowEMA);
- calcSingal.push(KO);
- // Calculate signal SMA
- if (calcSingal.length >= params.signalPeriod) {
- signal = calcSingal.slice(-params.signalPeriod)
- .reduce(function (prev, curr) {
- return prev + curr;
- }) / params.signalPeriod;
- }
- Klinger.push([xVal[i], KO, signal]);
- xData.push(xVal[i]);
- yData.push([KO, signal]);
- }
- }
- return {
- values: Klinger,
- xData: xData,
- yData: yData
- };
- };
- /**
- * Klinger oscillator. This series requires the `linkedTo` option to be set
- * and should be loaded after the `stock/indicators/indicators.js` file.
- *
- * @sample stock/indicators/klinger
- * Klinger oscillator
- *
- * @extends plotOptions.sma
- * @since 9.1.0
- * @product highstock
- * @requires stock/indicators/indicators
- * @requires stock/indicators/klinger
- * @optionparent plotOptions.klinger
- */
- KlingerIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
- /**
- * Paramters used in calculation of Klinger Oscillator.
- *
- * @excluding index, period
- */
- params: {
- /**
- * The fast period for indicator calculations.
- */
- fastAvgPeriod: 34,
- /**
- * The slow period for indicator calculations.
- */
- slowAvgPeriod: 55,
- /**
- * The base period for signal calculations.
- */
- signalPeriod: 13,
- /**
- * The id of another series to use its data as volume data for the
- * indiator calculation.
- */
- volumeSeriesID: 'volume'
- },
- signalLine: {
- /**
- * Styles for a signal line.
- */
- styles: {
- /**
- * Pixel width of the line.
- */
- lineWidth: 1,
- /**
- * Color of the line. If not set, it's inherited from
- * [plotOptions.klinger.color
- * ](#plotOptions.klinger.color).
- *
- * @type {Highcharts.ColorString}
- */
- lineColor: '#ff0000'
- }
- },
- dataGrouping: {
- approximation: 'averages'
- },
- tooltip: {
- pointFormat: '<span style="color: {point.color}">\u25CF</span><b> {series.name}</b><br/>' +
- '<span style="color: {point.color}">Klinger</span>: {point.y}<br/>' +
- '<span style="color: {point.series.options.signalLine.styles.lineColor}">Signal</span>' +
- ': {point.signal}<br/>'
- }
- });
- return KlingerIndicator;
- }(SMAIndicator));
- extend(KlingerIndicator.prototype, {
- linesApiNames: ['signalLine'],
- nameBase: 'Klinger',
- nameComponents: ['fastAvgPeriod', 'slowAvgPeriod'],
- pointArrayMap: ['y', 'signal'],
- parallelArrays: ['x', 'y', 'signal'],
- pointValKey: 'y',
- drawGraph: MultipleLinesMixin.drawGraph,
- getTranslatedLinesNames: MultipleLinesMixin.getTranslatedLinesNames,
- translate: MultipleLinesMixin.translate,
- toYData: MultipleLinesMixin.toYData
- });
- SeriesRegistry.registerSeriesType('klinger', KlingerIndicator);
- /* *
- *
- * Default Export
- *
- * */
- /**
- * A Klinger oscillator. If the [type](#series.klinger.type)
- * option is not specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends series,plotOptions.klinger
- * @since 9.1.0
- * @product highstock
- * @requires stock/indicators/indicators
- * @requires stock/indicators/ema
- * @requires stock/indicators/klinger
- * @apioption series.klinger
- */
- ''; // to include the above in the js output
- return KlingerIndicator;
- });
- _registerModule(_modules, 'masters/indicators/klinger.src.js', [], function () {
- });
- }));
|