broken-axis.src.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612
  1. /**
  2. * @license Highcharts JS v9.0.1 (2021-02-16)
  3. *
  4. * (c) 2009-2021 Torstein Honsi
  5. *
  6. * License: www.highcharts.com/license
  7. */
  8. 'use strict';
  9. (function (factory) {
  10. if (typeof module === 'object' && module.exports) {
  11. factory['default'] = factory;
  12. module.exports = factory;
  13. } else if (typeof define === 'function' && define.amd) {
  14. define('highcharts/modules/broken-axis', ['highcharts'], function (Highcharts) {
  15. factory(Highcharts);
  16. factory.Highcharts = Highcharts;
  17. return factory;
  18. });
  19. } else {
  20. factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
  21. }
  22. }(function (Highcharts) {
  23. var _modules = Highcharts ? Highcharts._modules : {};
  24. function _registerModule(obj, path, args, fn) {
  25. if (!obj.hasOwnProperty(path)) {
  26. obj[path] = fn.apply(null, args);
  27. }
  28. }
  29. _registerModule(_modules, 'Core/Axis/BrokenAxis.js', [_modules['Core/Axis/Axis.js'], _modules['Core/Series/Series.js'], _modules['Extensions/Stacking.js'], _modules['Core/Utilities.js']], function (Axis, Series, StackItem, U) {
  30. /* *
  31. *
  32. * (c) 2009-2021 Torstein Honsi
  33. *
  34. * License: www.highcharts.com/license
  35. *
  36. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  37. *
  38. * */
  39. var addEvent = U.addEvent,
  40. find = U.find,
  41. fireEvent = U.fireEvent,
  42. isArray = U.isArray,
  43. isNumber = U.isNumber,
  44. pick = U.pick;
  45. /* eslint-disable valid-jsdoc */
  46. /**
  47. * Provides support for broken axes.
  48. * @private
  49. * @class
  50. */
  51. var BrokenAxisAdditions = /** @class */ (function () {
  52. /* *
  53. *
  54. * Constructors
  55. *
  56. * */
  57. function BrokenAxisAdditions(axis) {
  58. this.hasBreaks = false;
  59. this.axis = axis;
  60. }
  61. /* *
  62. *
  63. * Static Functions
  64. *
  65. * */
  66. /**
  67. * @private
  68. */
  69. BrokenAxisAdditions.isInBreak = function (brk, val) {
  70. var ret,
  71. repeat = brk.repeat || Infinity,
  72. from = brk.from,
  73. length = brk.to - brk.from,
  74. test = (val >= from ?
  75. (val - from) % repeat :
  76. repeat - ((from - val) % repeat));
  77. if (!brk.inclusive) {
  78. ret = test < length && test !== 0;
  79. }
  80. else {
  81. ret = test <= length;
  82. }
  83. return ret;
  84. };
  85. /**
  86. * @private
  87. */
  88. BrokenAxisAdditions.lin2Val = function (val) {
  89. var axis = this;
  90. var brokenAxis = axis.brokenAxis;
  91. var breakArray = brokenAxis && brokenAxis.breakArray;
  92. if (!breakArray) {
  93. return val;
  94. }
  95. var nval = val,
  96. brk,
  97. i;
  98. for (i = 0; i < breakArray.length; i++) {
  99. brk = breakArray[i];
  100. if (brk.from >= nval) {
  101. break;
  102. }
  103. else if (brk.to < nval) {
  104. nval += brk.len;
  105. }
  106. else if (BrokenAxisAdditions.isInBreak(brk, nval)) {
  107. nval += brk.len;
  108. }
  109. }
  110. return nval;
  111. };
  112. /**
  113. * @private
  114. */
  115. BrokenAxisAdditions.val2Lin = function (val) {
  116. var axis = this;
  117. var brokenAxis = axis.brokenAxis;
  118. var breakArray = brokenAxis && brokenAxis.breakArray;
  119. if (!breakArray) {
  120. return val;
  121. }
  122. var nval = val,
  123. brk,
  124. i;
  125. for (i = 0; i < breakArray.length; i++) {
  126. brk = breakArray[i];
  127. if (brk.to <= val) {
  128. nval -= brk.len;
  129. }
  130. else if (brk.from >= val) {
  131. break;
  132. }
  133. else if (BrokenAxisAdditions.isInBreak(brk, val)) {
  134. nval -= (val - brk.from);
  135. break;
  136. }
  137. }
  138. return nval;
  139. };
  140. /* *
  141. *
  142. * Functions
  143. *
  144. * */
  145. /**
  146. * Returns the first break found where the x is larger then break.from and
  147. * smaller then break.to.
  148. *
  149. * @param {number} x
  150. * The number which should be within a break.
  151. *
  152. * @param {Array<Highcharts.XAxisBreaksOptions>} breaks
  153. * The array of breaks to search within.
  154. *
  155. * @return {Highcharts.XAxisBreaksOptions|undefined}
  156. * Returns the first break found that matches, returns false if no break is
  157. * found.
  158. */
  159. BrokenAxisAdditions.prototype.findBreakAt = function (x, breaks) {
  160. return find(breaks, function (b) {
  161. return b.from < x && x < b.to;
  162. });
  163. };
  164. /**
  165. * @private
  166. */
  167. BrokenAxisAdditions.prototype.isInAnyBreak = function (val, testKeep) {
  168. var brokenAxis = this;
  169. var axis = brokenAxis.axis;
  170. var breaks = axis.options.breaks,
  171. i = breaks && breaks.length,
  172. inbrk,
  173. keep,
  174. ret;
  175. if (i) {
  176. while (i--) {
  177. if (BrokenAxisAdditions.isInBreak(breaks[i], val)) {
  178. inbrk = true;
  179. if (!keep) {
  180. keep = pick(breaks[i].showPoints, !axis.isXAxis);
  181. }
  182. }
  183. }
  184. if (inbrk && testKeep) {
  185. ret = inbrk && !keep;
  186. }
  187. else {
  188. ret = inbrk;
  189. }
  190. }
  191. return ret;
  192. };
  193. /**
  194. * Dynamically set or unset breaks in an axis. This function in lighter than
  195. * usin Axis.update, and it also preserves animation.
  196. *
  197. * @private
  198. * @function Highcharts.Axis#setBreaks
  199. *
  200. * @param {Array<Highcharts.XAxisBreaksOptions>} [breaks]
  201. * The breaks to add. When `undefined` it removes existing breaks.
  202. *
  203. * @param {boolean} [redraw=true]
  204. * Whether to redraw the chart immediately.
  205. *
  206. * @return {void}
  207. */
  208. BrokenAxisAdditions.prototype.setBreaks = function (breaks, redraw) {
  209. var brokenAxis = this;
  210. var axis = brokenAxis.axis;
  211. var hasBreaks = (isArray(breaks) && !!breaks.length);
  212. axis.isDirty = brokenAxis.hasBreaks !== hasBreaks;
  213. brokenAxis.hasBreaks = hasBreaks;
  214. axis.options.breaks = axis.userOptions.breaks = breaks;
  215. axis.forceRedraw = true; // Force recalculation in setScale
  216. // Recalculate series related to the axis.
  217. axis.series.forEach(function (series) {
  218. series.isDirty = true;
  219. });
  220. if (!hasBreaks && axis.val2lin === BrokenAxisAdditions.val2Lin) {
  221. // Revert to prototype functions
  222. delete axis.val2lin;
  223. delete axis.lin2val;
  224. }
  225. if (hasBreaks) {
  226. axis.userOptions.ordinal = false;
  227. axis.lin2val = BrokenAxisAdditions.lin2Val;
  228. axis.val2lin = BrokenAxisAdditions.val2Lin;
  229. axis.setExtremes = function (newMin, newMax, redraw, animation, eventArguments) {
  230. // If trying to set extremes inside a break, extend min to
  231. // after, and max to before the break ( #3857 )
  232. if (brokenAxis.hasBreaks) {
  233. var axisBreak,
  234. breaks = this.options.breaks;
  235. while ((axisBreak = brokenAxis.findBreakAt(newMin, breaks))) {
  236. newMin = axisBreak.to;
  237. }
  238. while ((axisBreak = brokenAxis.findBreakAt(newMax, breaks))) {
  239. newMax = axisBreak.from;
  240. }
  241. // If both min and max is within the same break.
  242. if (newMax < newMin) {
  243. newMax = newMin;
  244. }
  245. }
  246. Axis.prototype.setExtremes.call(this, newMin, newMax, redraw, animation, eventArguments);
  247. };
  248. axis.setAxisTranslation = function () {
  249. Axis.prototype.setAxisTranslation.call(this);
  250. brokenAxis.unitLength = null;
  251. if (brokenAxis.hasBreaks) {
  252. var breaks = axis.options.breaks || [],
  253. // Temporary one:
  254. breakArrayT = [],
  255. breakArray = [],
  256. length = 0,
  257. inBrk,
  258. repeat,
  259. min = axis.userMin || axis.min,
  260. max = axis.userMax || axis.max,
  261. pointRangePadding = pick(axis.pointRangePadding, 0),
  262. start,
  263. i;
  264. // Min & max check (#4247)
  265. breaks.forEach(function (brk) {
  266. repeat = brk.repeat || Infinity;
  267. if (BrokenAxisAdditions.isInBreak(brk, min)) {
  268. min +=
  269. (brk.to % repeat) -
  270. (min % repeat);
  271. }
  272. if (BrokenAxisAdditions.isInBreak(brk, max)) {
  273. max -=
  274. (max % repeat) -
  275. (brk.from % repeat);
  276. }
  277. });
  278. // Construct an array holding all breaks in the axis
  279. breaks.forEach(function (brk) {
  280. start = brk.from;
  281. repeat = brk.repeat || Infinity;
  282. while (start - repeat > min) {
  283. start -= repeat;
  284. }
  285. while (start < min) {
  286. start += repeat;
  287. }
  288. for (i = start; i < max; i += repeat) {
  289. breakArrayT.push({
  290. value: i,
  291. move: 'in'
  292. });
  293. breakArrayT.push({
  294. value: i + (brk.to - brk.from),
  295. move: 'out',
  296. size: brk.breakSize
  297. });
  298. }
  299. });
  300. breakArrayT.sort(function (a, b) {
  301. return ((a.value === b.value) ?
  302. ((a.move === 'in' ? 0 : 1) -
  303. (b.move === 'in' ? 0 : 1)) :
  304. a.value - b.value);
  305. });
  306. // Simplify the breaks
  307. inBrk = 0;
  308. start = min;
  309. breakArrayT.forEach(function (brk) {
  310. inBrk += (brk.move === 'in' ? 1 : -1);
  311. if (inBrk === 1 && brk.move === 'in') {
  312. start = brk.value;
  313. }
  314. if (inBrk === 0) {
  315. breakArray.push({
  316. from: start,
  317. to: brk.value,
  318. len: brk.value - start - (brk.size || 0)
  319. });
  320. length += brk.value - start - (brk.size || 0);
  321. }
  322. });
  323. /**
  324. * HC <= 8 backwards compatibility, used by demo samples.
  325. * @deprecated
  326. * @private
  327. * @requires modules/broken-axis
  328. */
  329. axis.breakArray = brokenAxis.breakArray = breakArray;
  330. // Used with staticScale, and below the actual axis length,
  331. // when breaks are substracted.
  332. brokenAxis.unitLength = max - min - length + pointRangePadding;
  333. fireEvent(axis, 'afterBreaks');
  334. if (axis.staticScale) {
  335. axis.transA = axis.staticScale;
  336. }
  337. else if (brokenAxis.unitLength) {
  338. axis.transA *=
  339. (max - axis.min + pointRangePadding) /
  340. brokenAxis.unitLength;
  341. }
  342. if (pointRangePadding) {
  343. axis.minPixelPadding =
  344. axis.transA * axis.minPointOffset;
  345. }
  346. axis.min = min;
  347. axis.max = max;
  348. }
  349. };
  350. }
  351. if (pick(redraw, true)) {
  352. axis.chart.redraw();
  353. }
  354. };
  355. return BrokenAxisAdditions;
  356. }());
  357. /**
  358. * Axis with support of broken data rows.
  359. * @private
  360. * @class
  361. */
  362. var BrokenAxis = /** @class */ (function () {
  363. function BrokenAxis() {
  364. }
  365. /**
  366. * Adds support for broken axes.
  367. * @private
  368. */
  369. BrokenAxis.compose = function (AxisClass, SeriesClass) {
  370. AxisClass.keepProps.push('brokenAxis');
  371. var seriesProto = Series.prototype;
  372. /**
  373. * @private
  374. */
  375. seriesProto.drawBreaks = function (axis, keys) {
  376. var series = this,
  377. points = series.points,
  378. breaks,
  379. threshold,
  380. eventName,
  381. y;
  382. if (axis && // #5950
  383. axis.brokenAxis &&
  384. axis.brokenAxis.hasBreaks) {
  385. var brokenAxis_1 = axis.brokenAxis;
  386. keys.forEach(function (key) {
  387. breaks = brokenAxis_1 && brokenAxis_1.breakArray || [];
  388. threshold = axis.isXAxis ?
  389. axis.min :
  390. pick(series.options.threshold, axis.min);
  391. points.forEach(function (point) {
  392. y = pick(point['stack' + key.toUpperCase()], point[key]);
  393. breaks.forEach(function (brk) {
  394. if (isNumber(threshold) && isNumber(y)) {
  395. eventName = false;
  396. if ((threshold < brk.from && y > brk.to) ||
  397. (threshold > brk.from && y < brk.from)) {
  398. eventName = 'pointBreak';
  399. }
  400. else if ((threshold < brk.from && y > brk.from && y < brk.to) ||
  401. (threshold > brk.from && y > brk.to && y < brk.from)) {
  402. eventName = 'pointInBreak';
  403. }
  404. if (eventName) {
  405. fireEvent(axis, eventName, { point: point, brk: brk });
  406. }
  407. }
  408. });
  409. });
  410. });
  411. }
  412. };
  413. /**
  414. * Extend getGraphPath by identifying gaps in the data so that we can
  415. * draw a gap in the line or area. This was moved from ordinal axis
  416. * module to broken axis module as of #5045.
  417. *
  418. * @private
  419. * @function Highcharts.Series#gappedPath
  420. *
  421. * @return {Highcharts.SVGPathArray}
  422. * Gapped path
  423. */
  424. seriesProto.gappedPath = function () {
  425. var currentDataGrouping = this.currentDataGrouping,
  426. groupingSize = currentDataGrouping && currentDataGrouping.gapSize,
  427. gapSize = this.options.gapSize,
  428. points = this.points.slice(),
  429. i = points.length - 1,
  430. yAxis = this.yAxis,
  431. stack;
  432. /**
  433. * Defines when to display a gap in the graph, together with the
  434. * [gapUnit](plotOptions.series.gapUnit) option.
  435. *
  436. * In case when `dataGrouping` is enabled, points can be grouped
  437. * into a larger time span. This can make the grouped points to have
  438. * a greater distance than the absolute value of `gapSize` property,
  439. * which will result in disappearing graph completely. To prevent
  440. * this situation the mentioned distance between grouped points is
  441. * used instead of previously defined `gapSize`.
  442. *
  443. * In practice, this option is most often used to visualize gaps in
  444. * time series. In a stock chart, intraday data is available for
  445. * daytime hours, while gaps will appear in nights and weekends.
  446. *
  447. * @see [gapUnit](plotOptions.series.gapUnit)
  448. * @see [xAxis.breaks](#xAxis.breaks)
  449. *
  450. * @sample {highstock} stock/plotoptions/series-gapsize/
  451. * Setting the gap size to 2 introduces gaps for weekends
  452. * in daily datasets.
  453. *
  454. * @type {number}
  455. * @default 0
  456. * @product highstock
  457. * @requires modules/broken-axis
  458. * @apioption plotOptions.series.gapSize
  459. */
  460. /**
  461. * Together with [gapSize](plotOptions.series.gapSize), this option
  462. * defines where to draw gaps in the graph.
  463. *
  464. * When the `gapUnit` is `"relative"` (default), a gap size of 5
  465. * means that if the distance between two points is greater than
  466. * 5 times that of the two closest points, the graph will be broken.
  467. *
  468. * When the `gapUnit` is `"value"`, the gap is based on absolute
  469. * axis values, which on a datetime axis is milliseconds. This also
  470. * applies to the navigator series that inherits gap options from
  471. * the base series.
  472. *
  473. * @see [gapSize](plotOptions.series.gapSize)
  474. *
  475. * @type {string}
  476. * @default relative
  477. * @since 5.0.13
  478. * @product highstock
  479. * @validvalue ["relative", "value"]
  480. * @requires modules/broken-axis
  481. * @apioption plotOptions.series.gapUnit
  482. */
  483. if (gapSize && i > 0) { // #5008
  484. // Gap unit is relative
  485. if (this.options.gapUnit !== 'value') {
  486. gapSize *= this.basePointRange;
  487. }
  488. // Setting a new gapSize in case dataGrouping is enabled (#7686)
  489. if (groupingSize &&
  490. groupingSize > gapSize &&
  491. // Except when DG is forced (e.g. from other series)
  492. // and has lower granularity than actual points (#11351)
  493. groupingSize >= this.basePointRange) {
  494. gapSize = groupingSize;
  495. }
  496. // extension for ordinal breaks
  497. var current = void 0,
  498. next = void 0;
  499. while (i--) {
  500. // Reassign next if it is not visible
  501. if (!(next && next.visible !== false)) {
  502. next = points[i + 1];
  503. }
  504. current = points[i];
  505. // Skip iteration if one of the points is not visible
  506. if (next.visible === false || current.visible === false) {
  507. continue;
  508. }
  509. if (next.x - current.x > gapSize) {
  510. var xRange = (current.x + next.x) / 2;
  511. points.splice(// insert after this one
  512. i + 1, 0, {
  513. isNull: true,
  514. x: xRange
  515. });
  516. // For stacked chart generate empty stack items, #6546
  517. if (yAxis.stacking && this.options.stacking) {
  518. stack = yAxis.stacking.stacks[this.stackKey][xRange] =
  519. new StackItem(yAxis, yAxis.options
  520. .stackLabels, false, xRange, this.stack);
  521. stack.total = 0;
  522. }
  523. }
  524. // Assign current to next for the upcoming iteration
  525. next = current;
  526. }
  527. }
  528. // Call base method
  529. return this.getGraphPath(points);
  530. };
  531. /* eslint-disable no-invalid-this */
  532. addEvent(AxisClass, 'init', function () {
  533. var axis = this;
  534. if (!axis.brokenAxis) {
  535. axis.brokenAxis = new BrokenAxisAdditions(axis);
  536. }
  537. });
  538. addEvent(AxisClass, 'afterInit', function () {
  539. if (typeof this.brokenAxis !== 'undefined') {
  540. this.brokenAxis.setBreaks(this.options.breaks, false);
  541. }
  542. });
  543. addEvent(AxisClass, 'afterSetTickPositions', function () {
  544. var axis = this;
  545. var brokenAxis = axis.brokenAxis;
  546. if (brokenAxis &&
  547. brokenAxis.hasBreaks) {
  548. var tickPositions = this.tickPositions,
  549. info = this.tickPositions.info,
  550. newPositions = [],
  551. i;
  552. for (i = 0; i < tickPositions.length; i++) {
  553. if (!brokenAxis.isInAnyBreak(tickPositions[i])) {
  554. newPositions.push(tickPositions[i]);
  555. }
  556. }
  557. this.tickPositions = newPositions;
  558. this.tickPositions.info = info;
  559. }
  560. });
  561. // Force Axis to be not-ordinal when breaks are defined
  562. addEvent(AxisClass, 'afterSetOptions', function () {
  563. if (this.brokenAxis && this.brokenAxis.hasBreaks) {
  564. this.options.ordinal = false;
  565. }
  566. });
  567. addEvent(SeriesClass, 'afterGeneratePoints', function () {
  568. var _a = this,
  569. isDirty = _a.isDirty,
  570. connectNulls = _a.options.connectNulls,
  571. points = _a.points,
  572. xAxis = _a.xAxis,
  573. yAxis = _a.yAxis;
  574. // Set, or reset visibility of the points. Axis.setBreaks marks the
  575. // series as isDirty
  576. if (isDirty) {
  577. var i = points.length;
  578. while (i--) {
  579. var point = points[i];
  580. // Respect nulls inside the break (#4275)
  581. var nullGap = point.y === null && connectNulls === false;
  582. var isPointInBreak = (!nullGap && ((xAxis &&
  583. xAxis.brokenAxis &&
  584. xAxis.brokenAxis.isInAnyBreak(point.x,
  585. true)) || (yAxis &&
  586. yAxis.brokenAxis &&
  587. yAxis.brokenAxis.isInAnyBreak(point.y,
  588. true))));
  589. // Set point.visible if in any break.
  590. // If not in break, reset visible to original value.
  591. point.visible = isPointInBreak ?
  592. false :
  593. point.options.visible !== false;
  594. }
  595. }
  596. });
  597. addEvent(SeriesClass, 'afterRender', function drawPointsWrapped() {
  598. this.drawBreaks(this.xAxis, ['x']);
  599. this.drawBreaks(this.yAxis, pick(this.pointArrayMap, ['y']));
  600. });
  601. };
  602. return BrokenAxis;
  603. }());
  604. BrokenAxis.compose(Axis, Series); // @todo remove automatism
  605. return BrokenAxis;
  606. });
  607. _registerModule(_modules, 'masters/modules/broken-axis.src.js', [], function () {
  608. });
  609. }));