/**
|
*
|
* (c) 2010-2019 Wojciech Chmiel
|
*
|
* License: www.highcharts.com/license
|
*
|
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
|
*
|
* */
|
'use strict';
|
|
Object.defineProperty(exports, "__esModule", {
|
value: true
|
});
|
|
var _Globals = require('../parts/Globals.js');
|
|
var _Globals2 = _interopRequireDefault(_Globals);
|
|
var _Utilities = require('../parts/Utilities.js');
|
|
var _Utilities2 = _interopRequireDefault(_Utilities);
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
var defined = _Utilities2.default.defined;
|
var each = _Globals2.default.each,
|
merge = _Globals2.default.merge,
|
error = _Globals2.default.error,
|
SMA = _Globals2.default.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 getTranslatedLinesNames(excludedValue) {
|
var translatedLines = [];
|
each(this.pointArrayMap, 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 toYData(point) {
|
var pointColl = [];
|
each(this.pointArrayMap, function (propertyName) {
|
pointColl.push(point[propertyName]);
|
});
|
return pointColl;
|
},
|
/**
|
* Add lines plot pixel values.
|
*
|
* @private
|
* @function multipleLinesMixin.translate
|
* @return {void}
|
*/
|
translate: function translate() {
|
var indicator = this,
|
pointArrayMap = indicator.pointArrayMap,
|
LinesNames = [],
|
value;
|
LinesNames = indicator.getTranslatedLinesNames();
|
SMA.prototype.translate.apply(indicator, arguments);
|
each(indicator.points, function (point) {
|
each(pointArrayMap, 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 drawGraph() {
|
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:
|
each(secondaryLinesNames, 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:
|
each(linesApiNames, 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);
|
}
|
};
|
exports.default = multipleLinesMixin;
|
