acceleration-bands.src.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. /**
  2. * @license Highstock JS v9.1.1 (2021-06-04)
  3. *
  4. * Indicator series type for Highcharts Stock
  5. *
  6. * (c) 2010-2021 Daniel Studencki
  7. *
  8. * License: www.highcharts.com/license
  9. */
  10. 'use strict';
  11. (function (factory) {
  12. if (typeof module === 'object' && module.exports) {
  13. factory['default'] = factory;
  14. module.exports = factory;
  15. } else if (typeof define === 'function' && define.amd) {
  16. define('highcharts/indicators/acceleration-bands', ['highcharts', 'highcharts/modules/stock'], function (Highcharts) {
  17. factory(Highcharts);
  18. factory.Highcharts = Highcharts;
  19. return factory;
  20. });
  21. } else {
  22. factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
  23. }
  24. }(function (Highcharts) {
  25. var _modules = Highcharts ? Highcharts._modules : {};
  26. function _registerModule(obj, path, args, fn) {
  27. if (!obj.hasOwnProperty(path)) {
  28. obj[path] = fn.apply(null, args);
  29. }
  30. }
  31. _registerModule(_modules, 'Mixins/MultipleLines.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) {
  32. /**
  33. *
  34. * (c) 2010-2021 Wojciech Chmiel
  35. *
  36. * License: www.highcharts.com/license
  37. *
  38. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  39. *
  40. * */
  41. var defined = U.defined,
  42. error = U.error,
  43. merge = U.merge;
  44. var SMA = H.seriesTypes.sma;
  45. /**
  46. * Mixin useful for all indicators that have more than one line.
  47. * Merge it with your implementation where you will provide
  48. * getValues method appropriate to your indicator and pointArrayMap,
  49. * pointValKey, linesApiNames properites. Notice that pointArrayMap
  50. * should be consistent with amount of lines calculated in getValues method.
  51. *
  52. * @private
  53. * @mixin multipleLinesMixin
  54. */
  55. var multipleLinesMixin = {
  56. /* eslint-disable valid-jsdoc */
  57. /**
  58. * Lines ids. Required to plot appropriate amount of lines.
  59. * Notice that pointArrayMap should have more elements than
  60. * linesApiNames, because it contains main line and additional lines ids.
  61. * Also it should be consistent with amount of lines calculated in
  62. * getValues method from your implementation.
  63. *
  64. * @private
  65. * @name multipleLinesMixin.pointArrayMap
  66. * @type {Array<string>}
  67. */
  68. pointArrayMap: ['top', 'bottom'],
  69. /**
  70. * Main line id.
  71. *
  72. * @private
  73. * @name multipleLinesMixin.pointValKey
  74. * @type {string}
  75. */
  76. pointValKey: 'top',
  77. /**
  78. * Additional lines DOCS names. Elements of linesApiNames array should
  79. * be consistent with DOCS line names defined in your implementation.
  80. * Notice that linesApiNames should have decreased amount of elements
  81. * relative to pointArrayMap (without pointValKey).
  82. *
  83. * @private
  84. * @name multipleLinesMixin.linesApiNames
  85. * @type {Array<string>}
  86. */
  87. linesApiNames: ['bottomLine'],
  88. /**
  89. * Create translatedLines Collection based on pointArrayMap.
  90. *
  91. * @private
  92. * @function multipleLinesMixin.getTranslatedLinesNames
  93. * @param {string} [excludedValue]
  94. * Main line id
  95. * @return {Array<string>}
  96. * Returns translated lines names without excluded value.
  97. */
  98. getTranslatedLinesNames: function (excludedValue) {
  99. var translatedLines = [];
  100. (this.pointArrayMap || []).forEach(function (propertyName) {
  101. if (propertyName !== excludedValue) {
  102. translatedLines.push('plot' +
  103. propertyName.charAt(0).toUpperCase() +
  104. propertyName.slice(1));
  105. }
  106. });
  107. return translatedLines;
  108. },
  109. /**
  110. * @private
  111. * @function multipleLinesMixin.toYData
  112. * @param {Highcharts.Point} point
  113. * Indicator point
  114. * @return {Array<number>}
  115. * Returns point Y value for all lines
  116. */
  117. toYData: function (point) {
  118. var pointColl = [];
  119. (this.pointArrayMap || []).forEach(function (propertyName) {
  120. pointColl.push(point[propertyName]);
  121. });
  122. return pointColl;
  123. },
  124. /**
  125. * Add lines plot pixel values.
  126. *
  127. * @private
  128. * @function multipleLinesMixin.translate
  129. * @return {void}
  130. */
  131. translate: function () {
  132. var indicator = this,
  133. pointArrayMap = indicator.pointArrayMap,
  134. LinesNames = [],
  135. value;
  136. LinesNames = indicator.getTranslatedLinesNames();
  137. SMA.prototype.translate.apply(indicator, arguments);
  138. indicator.points.forEach(function (point) {
  139. pointArrayMap.forEach(function (propertyName, i) {
  140. value = point[propertyName];
  141. if (value !== null) {
  142. point[LinesNames[i]] = indicator.yAxis.toPixels(value, true);
  143. }
  144. });
  145. });
  146. },
  147. /**
  148. * Draw main and additional lines.
  149. *
  150. * @private
  151. * @function multipleLinesMixin.drawGraph
  152. * @return {void}
  153. */
  154. drawGraph: function () {
  155. var indicator = this,
  156. pointValKey = indicator.pointValKey,
  157. linesApiNames = indicator.linesApiNames,
  158. mainLinePoints = indicator.points,
  159. pointsLength = mainLinePoints.length,
  160. mainLineOptions = indicator.options,
  161. mainLinePath = indicator.graph,
  162. gappedExtend = {
  163. options: {
  164. gapSize: mainLineOptions.gapSize
  165. }
  166. },
  167. // additional lines point place holders:
  168. secondaryLines = [],
  169. secondaryLinesNames = indicator.getTranslatedLinesNames(pointValKey),
  170. point;
  171. // Generate points for additional lines:
  172. secondaryLinesNames.forEach(function (plotLine, index) {
  173. // create additional lines point place holders
  174. secondaryLines[index] = [];
  175. while (pointsLength--) {
  176. point = mainLinePoints[pointsLength];
  177. secondaryLines[index].push({
  178. x: point.x,
  179. plotX: point.plotX,
  180. plotY: point[plotLine],
  181. isNull: !defined(point[plotLine])
  182. });
  183. }
  184. pointsLength = mainLinePoints.length;
  185. });
  186. // Modify options and generate additional lines:
  187. linesApiNames.forEach(function (lineName, i) {
  188. if (secondaryLines[i]) {
  189. indicator.points = secondaryLines[i];
  190. if (mainLineOptions[lineName]) {
  191. indicator.options = merge(mainLineOptions[lineName].styles, gappedExtend);
  192. }
  193. else {
  194. error('Error: "There is no ' + lineName +
  195. ' in DOCS options declared. Check if linesApiNames' +
  196. ' are consistent with your DOCS line names."' +
  197. ' at mixin/multiple-line.js:34');
  198. }
  199. indicator.graph = indicator['graph' + lineName];
  200. SMA.prototype.drawGraph.call(indicator);
  201. // Now save lines:
  202. indicator['graph' + lineName] = indicator.graph;
  203. }
  204. else {
  205. error('Error: "' + lineName + ' doesn\'t have equivalent ' +
  206. 'in pointArrayMap. To many elements in linesApiNames ' +
  207. 'relative to pointArrayMap."');
  208. }
  209. });
  210. // Restore options and draw a main line:
  211. indicator.points = mainLinePoints;
  212. indicator.options = mainLineOptions;
  213. indicator.graph = mainLinePath;
  214. SMA.prototype.drawGraph.call(indicator);
  215. }
  216. };
  217. return multipleLinesMixin;
  218. });
  219. _registerModule(_modules, 'Stock/Indicators/ABands/ABandsIndicator.js', [_modules['Mixins/MultipleLines.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (MultipleLinesMixin, SeriesRegistry, U) {
  220. /* *
  221. *
  222. * License: www.highcharts.com/license
  223. *
  224. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  225. *
  226. * */
  227. var __extends = (this && this.__extends) || (function () {
  228. var extendStatics = function (d,
  229. b) {
  230. extendStatics = Object.setPrototypeOf ||
  231. ({ __proto__: [] } instanceof Array && function (d,
  232. b) { d.__proto__ = b; }) ||
  233. function (d,
  234. b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
  235. return extendStatics(d, b);
  236. };
  237. return function (d, b) {
  238. extendStatics(d, b);
  239. function __() { this.constructor = d; }
  240. d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
  241. };
  242. })();
  243. var SMAIndicator = SeriesRegistry.seriesTypes.sma;
  244. var correctFloat = U.correctFloat,
  245. extend = U.extend,
  246. merge = U.merge;
  247. /* eslint-disable valid-jsdoc */
  248. /**
  249. * @private
  250. */
  251. function getBaseForBand(low, high, factor) {
  252. return (((correctFloat(high - low)) /
  253. ((correctFloat(high + low)) / 2)) * 1000) * factor;
  254. }
  255. /**
  256. * @private
  257. */
  258. function getPointUB(high, base) {
  259. return high * (correctFloat(1 + 2 * base));
  260. }
  261. /**
  262. * @private
  263. */
  264. function getPointLB(low, base) {
  265. return low * (correctFloat(1 - 2 * base));
  266. }
  267. /* eslint-enable valid-jsdoc */
  268. /**
  269. * The ABands series type
  270. *
  271. * @private
  272. * @class
  273. * @name Highcharts.seriesTypes.abands
  274. *
  275. * @augments Highcharts.Series
  276. */
  277. var ABandsIndicator = /** @class */ (function (_super) {
  278. __extends(ABandsIndicator, _super);
  279. function ABandsIndicator() {
  280. /* *
  281. *
  282. * Static Properties
  283. *
  284. * */
  285. var _this = _super !== null && _super.apply(this,
  286. arguments) || this;
  287. /* *
  288. *
  289. * Properties
  290. *
  291. * */
  292. _this.data = void 0;
  293. _this.options = void 0;
  294. _this.points = void 0;
  295. return _this;
  296. }
  297. /* *
  298. *
  299. * Functions
  300. *
  301. * */
  302. ABandsIndicator.prototype.getValues = function (series, params) {
  303. var period = params.period,
  304. factor = params.factor,
  305. index = params.index,
  306. xVal = series.xData,
  307. yVal = series.yData,
  308. yValLen = yVal ? yVal.length : 0,
  309. // Upperbands
  310. UB = [],
  311. // Lowerbands
  312. LB = [],
  313. // ABANDS array structure:
  314. // 0-date, 1-top line, 2-middle line, 3-bottom line
  315. ABANDS = [],
  316. // middle line, top line and bottom line
  317. ML,
  318. TL,
  319. BL,
  320. date,
  321. bandBase,
  322. pointSMA,
  323. ubSMA,
  324. lbSMA,
  325. low = 2,
  326. high = 1,
  327. xData = [],
  328. yData = [],
  329. slicedX,
  330. slicedY,
  331. i;
  332. if (yValLen < period) {
  333. return;
  334. }
  335. for (i = 0; i <= yValLen; i++) {
  336. // Get UB and LB values of every point. This condition
  337. // is necessary, because there is a need to calculate current
  338. // UB nad LB values simultaneously with given period SMA
  339. // in one for loop.
  340. if (i < yValLen) {
  341. bandBase = getBaseForBand(yVal[i][low], yVal[i][high], factor);
  342. UB.push(getPointUB(yVal[i][high], bandBase));
  343. LB.push(getPointLB(yVal[i][low], bandBase));
  344. }
  345. if (i >= period) {
  346. slicedX = xVal.slice(i - period, i);
  347. slicedY = yVal.slice(i - period, i);
  348. ubSMA = _super.prototype.getValues.call(this, {
  349. xData: slicedX,
  350. yData: UB.slice(i - period, i)
  351. }, {
  352. period: period
  353. });
  354. lbSMA = _super.prototype.getValues.call(this, {
  355. xData: slicedX,
  356. yData: LB.slice(i - period, i)
  357. }, {
  358. period: period
  359. });
  360. pointSMA = _super.prototype.getValues.call(this, {
  361. xData: slicedX,
  362. yData: slicedY
  363. }, {
  364. period: period,
  365. index: index
  366. });
  367. date = pointSMA.xData[0];
  368. TL = ubSMA.yData[0];
  369. BL = lbSMA.yData[0];
  370. ML = pointSMA.yData[0];
  371. ABANDS.push([date, TL, ML, BL]);
  372. xData.push(date);
  373. yData.push([TL, ML, BL]);
  374. }
  375. }
  376. return {
  377. values: ABANDS,
  378. xData: xData,
  379. yData: yData
  380. };
  381. };
  382. /**
  383. * Acceleration bands (ABANDS). This series requires the `linkedTo` option
  384. * to be set and should be loaded after the
  385. * `stock/indicators/indicators.js`.
  386. *
  387. * @sample {highstock} stock/indicators/acceleration-bands
  388. * Acceleration Bands
  389. *
  390. * @extends plotOptions.sma
  391. * @mixes Highcharts.MultipleLinesMixin
  392. * @since 7.0.0
  393. * @product highstock
  394. * @excluding allAreas, colorAxis, compare, compareBase, joinBy, keys,
  395. * navigatorOptions, pointInterval, pointIntervalUnit,
  396. * pointPlacement, pointRange, pointStart, showInNavigator,
  397. * stacking,
  398. * @requires stock/indicators/indicators
  399. * @requires stock/indicators/acceleration-bands
  400. * @optionparent plotOptions.abands
  401. */
  402. ABandsIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
  403. params: {
  404. period: 20,
  405. /**
  406. * The algorithms factor value used to calculate bands.
  407. *
  408. * @product highstock
  409. */
  410. factor: 0.001,
  411. index: 3
  412. },
  413. lineWidth: 1,
  414. topLine: {
  415. styles: {
  416. /**
  417. * Pixel width of the line.
  418. */
  419. lineWidth: 1
  420. }
  421. },
  422. bottomLine: {
  423. styles: {
  424. /**
  425. * Pixel width of the line.
  426. */
  427. lineWidth: 1
  428. }
  429. },
  430. dataGrouping: {
  431. approximation: 'averages'
  432. }
  433. });
  434. return ABandsIndicator;
  435. }(SMAIndicator));
  436. extend(ABandsIndicator.prototype, {
  437. drawGraph: MultipleLinesMixin.drawGraph,
  438. getTranslatedLinesNames: MultipleLinesMixin.getTranslatedLinesNames,
  439. linesApiNames: ['topLine', 'bottomLine'],
  440. nameBase: 'Acceleration Bands',
  441. nameComponents: ['period', 'factor'],
  442. pointArrayMap: ['top', 'middle', 'bottom'],
  443. pointValKey: 'middle',
  444. toYData: MultipleLinesMixin.toYData,
  445. translate: MultipleLinesMixin.translate
  446. });
  447. SeriesRegistry.registerSeriesType('abands', ABandsIndicator);
  448. /* *
  449. *
  450. * Default Export
  451. *
  452. * */
  453. /* *
  454. *
  455. * API Options
  456. *
  457. * */
  458. /**
  459. * An Acceleration bands indicator. If the [type](#series.abands.type) option is not
  460. * specified, it is inherited from [chart.type](#chart.type).
  461. *
  462. * @extends series,plotOptions.abands
  463. * @since 7.0.0
  464. * @product highstock
  465. * @excluding allAreas, colorAxis, compare, compareBase, dataParser, dataURL,
  466. * joinBy, keys, navigatorOptions, pointInterval,
  467. * pointIntervalUnit, pointPlacement, pointRange, pointStart,
  468. * stacking, showInNavigator,
  469. * @requires stock/indicators/indicators
  470. * @requires stock/indicators/acceleration-bands
  471. * @apioption series.abands
  472. */
  473. ''; // to include the above in jsdoc
  474. return ABandsIndicator;
  475. });
  476. _registerModule(_modules, 'masters/indicators/acceleration-bands.src.js', [], function () {
  477. });
  478. }));