highcharts
Version:
JavaScript charting framework
450 lines (446 loc) • 18.9 kB
JavaScript
/**
* @license Highstock JS v9.0.1 (2021-02-16)
*
* Indicator series type for Highstock
*
* (c) 2010-2021 Daniel Studencki
*
* License: www.highcharts.com/license
*/
;
(function (factory) {
if (typeof module === 'object' && module.exports) {
factory['default'] = factory;
module.exports = factory;
} else if (typeof define === 'function' && define.amd) {
define('highcharts/indicators/keltner-channels', ['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/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/KeltnerChannels/KeltnerChannelsIndicator.js', [_modules['Mixins/MultipleLines.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (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,
ATRIndicator = _a.atr;
var correctFloat = U.correctFloat,
extend = U.extend,
merge = U.merge;
/**
* The Keltner Channels series type.
*
* @private
* @class
* @name Highcharts.seriesTypes.keltnerchannels
*
* @augments Highcharts.Series
*/
var KeltnerChannelsIndicator = /** @class */ (function (_super) {
__extends(KeltnerChannelsIndicator, _super);
function KeltnerChannelsIndicator() {
var _this = _super !== null && _super.apply(this,
arguments) || this;
_this.data = void 0;
_this.options = void 0;
_this.points = void 0;
return _this;
}
KeltnerChannelsIndicator.prototype.init = function () {
SeriesRegistry.seriesTypes.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);
};
KeltnerChannelsIndicator.prototype.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 = [],
// middle line, top line and bottom lineI
ML,
TL,
BL,
date,
seriesEMA = SeriesRegistry.seriesTypes.ema.prototype.getValues(series, {
period: period,
index: index
}),
seriesATR = SeriesRegistry.seriesTypes.atr.prototype.getValues(series, {
period: periodATR
}),
pointEMA,
pointATR,
xData = [],
yData = [],
i;
if (yValLen < period) {
return;
}
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
};
};
/**
* 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
* @requires stock/indicators/indicators
* @requires stock/indicators/keltner-channels
* @optionparent plotOptions.keltnerchannels
*/
KeltnerChannelsIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
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: void 0
}
},
/**
* Top line options.
*
* @extends plotOptions.keltnerchannels.bottomLine
*/
topLine: {
styles: {
lineWidth: 1,
lineColor: void 0
}
},
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
});
return KeltnerChannelsIndicator;
}(SMAIndicator));
extend(KeltnerChannelsIndicator.prototype, {
pointArrayMap: ['top', 'middle', 'bottom'],
pointValKey: 'middle',
nameBase: 'Keltner Channels',
nameComponents: ['period', 'periodATR', 'multiplierATR'],
linesApiNames: ['topLine', 'bottomLine'],
requiredIndicators: ['ema', 'atr'],
drawGraph: MultipleLinesMixin.drawGraph,
getTranslatedLinesNames: MultipleLinesMixin.getTranslatedLinesNames,
translate: MultipleLinesMixin.translate,
toYData: MultipleLinesMixin.toYData
});
SeriesRegistry.registerSeriesType('keltnerchannels', KeltnerChannelsIndicator);
/* *
*
* Default Export
*
* */
/**
* 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.sma
* @since 7.0.0
* @product highstock
* @excluding allAreas, colorAxis, compare, compareBase, dataParser, dataURL,
* joinBy, keys, navigatorOptions, pointInterval,
* pointIntervalUnit, pointPlacement, pointRange, pointStart,
* stacking, showInNavigator
* @requires stock/indicators/indicators
* @requires stock/indicators/keltner-channels
* @apioption series.keltnerchannels
*/
''; // to include the above in the js output
return KeltnerChannelsIndicator;
});
_registerModule(_modules, 'masters/indicators/keltner-channels.src.js', [], function () {
});
}));