vis.js is a dynamic, browser-based visualization library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

877 lines
30 KiB

  1. var Emitter = require('emitter-component');
  2. var Hammer = require('../module/hammer');
  3. var util = require('../util');
  4. var DataSet = require('../DataSet');
  5. var DataView = require('../DataView');
  6. var Range = require('./Range');
  7. var ItemSet = require('./component/ItemSet');
  8. var Activator = require('../shared/Activator');
  9. var DateUtil = require('./DateUtil');
  10. /**
  11. * Create a timeline visualization
  12. * @param {HTMLElement} container
  13. * @param {vis.DataSet | Array | google.visualization.DataTable} [items]
  14. * @param {Object} [options] See Core.setOptions for the available options.
  15. * @constructor
  16. */
  17. function Core () {}
  18. // turn Core into an event emitter
  19. Emitter(Core.prototype);
  20. /**
  21. * Create the main DOM for the Core: a root panel containing left, right,
  22. * top, bottom, content, and background panel.
  23. * @param {Element} container The container element where the Core will
  24. * be attached.
  25. * @private
  26. */
  27. Core.prototype._create = function (container) {
  28. this.dom = {};
  29. this.dom.root = document.createElement('div');
  30. this.dom.background = document.createElement('div');
  31. this.dom.backgroundVertical = document.createElement('div');
  32. this.dom.backgroundHorizontal = document.createElement('div');
  33. this.dom.centerContainer = document.createElement('div');
  34. this.dom.leftContainer = document.createElement('div');
  35. this.dom.rightContainer = document.createElement('div');
  36. this.dom.center = document.createElement('div');
  37. this.dom.left = document.createElement('div');
  38. this.dom.right = document.createElement('div');
  39. this.dom.top = document.createElement('div');
  40. this.dom.bottom = document.createElement('div');
  41. this.dom.shadowTop = document.createElement('div');
  42. this.dom.shadowBottom = document.createElement('div');
  43. this.dom.shadowTopLeft = document.createElement('div');
  44. this.dom.shadowBottomLeft = document.createElement('div');
  45. this.dom.shadowTopRight = document.createElement('div');
  46. this.dom.shadowBottomRight = document.createElement('div');
  47. this.dom.root.className = 'vis timeline root';
  48. this.dom.background.className = 'vispanel background';
  49. this.dom.backgroundVertical.className = 'vispanel background vertical';
  50. this.dom.backgroundHorizontal.className = 'vispanel background horizontal';
  51. this.dom.centerContainer.className = 'vispanel center';
  52. this.dom.leftContainer.className = 'vispanel left';
  53. this.dom.rightContainer.className = 'vispanel right';
  54. this.dom.top.className = 'vispanel top';
  55. this.dom.bottom.className = 'vispanel bottom';
  56. this.dom.left.className = 'content';
  57. this.dom.center.className = 'content';
  58. this.dom.right.className = 'content';
  59. this.dom.shadowTop.className = 'shadow top';
  60. this.dom.shadowBottom.className = 'shadow bottom';
  61. this.dom.shadowTopLeft.className = 'shadow top';
  62. this.dom.shadowBottomLeft.className = 'shadow bottom';
  63. this.dom.shadowTopRight.className = 'shadow top';
  64. this.dom.shadowBottomRight.className = 'shadow bottom';
  65. this.dom.root.appendChild(this.dom.background);
  66. this.dom.root.appendChild(this.dom.backgroundVertical);
  67. this.dom.root.appendChild(this.dom.backgroundHorizontal);
  68. this.dom.root.appendChild(this.dom.centerContainer);
  69. this.dom.root.appendChild(this.dom.leftContainer);
  70. this.dom.root.appendChild(this.dom.rightContainer);
  71. this.dom.root.appendChild(this.dom.top);
  72. this.dom.root.appendChild(this.dom.bottom);
  73. this.dom.centerContainer.appendChild(this.dom.center);
  74. this.dom.leftContainer.appendChild(this.dom.left);
  75. this.dom.rightContainer.appendChild(this.dom.right);
  76. this.dom.centerContainer.appendChild(this.dom.shadowTop);
  77. this.dom.centerContainer.appendChild(this.dom.shadowBottom);
  78. this.dom.leftContainer.appendChild(this.dom.shadowTopLeft);
  79. this.dom.leftContainer.appendChild(this.dom.shadowBottomLeft);
  80. this.dom.rightContainer.appendChild(this.dom.shadowTopRight);
  81. this.dom.rightContainer.appendChild(this.dom.shadowBottomRight);
  82. this.on('rangechange', this._redraw.bind(this));
  83. this.on('touch', this._onTouch.bind(this));
  84. this.on('pinch', this._onPinch.bind(this));
  85. this.on('dragstart', this._onDragStart.bind(this));
  86. this.on('drag', this._onDrag.bind(this));
  87. var me = this;
  88. this.on('change', function (properties) {
  89. if (properties && properties.queue == true) {
  90. // redraw once on next tick
  91. if (!me._redrawTimer) {
  92. me._redrawTimer = setTimeout(function () {
  93. me._redrawTimer = null;
  94. me._redraw();
  95. }, 0)
  96. }
  97. }
  98. else {
  99. // redraw immediately
  100. me._redraw();
  101. }
  102. });
  103. // create event listeners for all interesting events, these events will be
  104. // emitted via emitter
  105. this.hammer = Hammer(this.dom.root, {
  106. preventDefault: true
  107. });
  108. this.listeners = {};
  109. var events = [
  110. 'touch', 'pinch',
  111. 'tap', 'doubletap', 'hold',
  112. 'dragstart', 'drag', 'dragend',
  113. 'mousewheel', 'DOMMouseScroll' // DOMMouseScroll is needed for Firefox
  114. ];
  115. events.forEach(function (event) {
  116. var listener = function () {
  117. var args = [event].concat(Array.prototype.slice.call(arguments, 0));
  118. if (me.isActive()) {
  119. me.emit.apply(me, args);
  120. }
  121. };
  122. me.hammer.on(event, listener);
  123. me.listeners[event] = listener;
  124. });
  125. // size properties of each of the panels
  126. this.props = {
  127. root: {},
  128. background: {},
  129. centerContainer: {},
  130. leftContainer: {},
  131. rightContainer: {},
  132. center: {},
  133. left: {},
  134. right: {},
  135. top: {},
  136. bottom: {},
  137. border: {},
  138. scrollTop: 0,
  139. scrollTopMin: 0
  140. };
  141. this.touch = {}; // store state information needed for touch events
  142. this.redrawCount = 0;
  143. // attach the root panel to the provided container
  144. if (!container) throw new Error('No container provided');
  145. container.appendChild(this.dom.root);
  146. };
  147. /**
  148. * Set options. Options will be passed to all components loaded in the Timeline.
  149. * @param {Object} [options]
  150. * {String} orientation
  151. * Vertical orientation for the Timeline,
  152. * can be 'bottom' (default) or 'top'.
  153. * {String | Number} width
  154. * Width for the timeline, a number in pixels or
  155. * a css string like '1000px' or '75%'. '100%' by default.
  156. * {String | Number} height
  157. * Fixed height for the Timeline, a number in pixels or
  158. * a css string like '400px' or '75%'. If undefined,
  159. * The Timeline will automatically size such that
  160. * its contents fit.
  161. * {String | Number} minHeight
  162. * Minimum height for the Timeline, a number in pixels or
  163. * a css string like '400px' or '75%'.
  164. * {String | Number} maxHeight
  165. * Maximum height for the Timeline, a number in pixels or
  166. * a css string like '400px' or '75%'.
  167. * {Number | Date | String} start
  168. * Start date for the visible window
  169. * {Number | Date | String} end
  170. * End date for the visible window
  171. */
  172. Core.prototype.setOptions = function (options) {
  173. if (options) {
  174. // copy the known options
  175. var fields = ['width', 'height', 'minHeight', 'maxHeight', 'autoResize', 'start', 'end', 'orientation', 'clickToUse', 'dataAttributes', 'hiddenDates'];
  176. util.selectiveExtend(fields, this.options, options);
  177. if ('hiddenDates' in this.options) {
  178. DateUtil.convertHiddenOptions(this.body, this.options.hiddenDates);
  179. }
  180. if ('clickToUse' in options) {
  181. if (options.clickToUse) {
  182. if (!this.activator) {
  183. this.activator = new Activator(this.dom.root);
  184. }
  185. }
  186. else {
  187. if (this.activator) {
  188. this.activator.destroy();
  189. delete this.activator;
  190. }
  191. }
  192. }
  193. // enable/disable autoResize
  194. this._initAutoResize();
  195. }
  196. // propagate options to all components
  197. this.components.forEach(component => component.setOptions(options));
  198. // TODO: remove deprecation error one day (deprecated since version 0.8.0)
  199. if (options && options.order) {
  200. throw new Error('Option order is deprecated. There is no replacement for this feature.');
  201. }
  202. // redraw everything
  203. this._redraw();
  204. };
  205. /**
  206. * Returns true when the Timeline is active.
  207. * @returns {boolean}
  208. */
  209. Core.prototype.isActive = function () {
  210. return !this.activator || this.activator.active;
  211. };
  212. /**
  213. * Destroy the Core, clean up all DOM elements and event listeners.
  214. */
  215. Core.prototype.destroy = function () {
  216. // unbind datasets
  217. this.clear();
  218. // remove all event listeners
  219. this.off();
  220. // stop checking for changed size
  221. this._stopAutoResize();
  222. // remove from DOM
  223. if (this.dom.root.parentNode) {
  224. this.dom.root.parentNode.removeChild(this.dom.root);
  225. }
  226. this.dom = null;
  227. // remove Activator
  228. if (this.activator) {
  229. this.activator.destroy();
  230. delete this.activator;
  231. }
  232. // cleanup hammer touch events
  233. for (var event in this.listeners) {
  234. if (this.listeners.hasOwnProperty(event)) {
  235. delete this.listeners[event];
  236. }
  237. }
  238. this.listeners = null;
  239. this.hammer = null;
  240. // give all components the opportunity to cleanup
  241. this.components.forEach(component => component.destroy());
  242. this.body = null;
  243. };
  244. /**
  245. * Set a custom time bar
  246. * @param {Date} time
  247. */
  248. Core.prototype.setCustomTime = function (time) {
  249. if (!this.customTime) {
  250. throw new Error('Cannot get custom time: Custom time bar is not enabled');
  251. }
  252. this.customTime.setCustomTime(time);
  253. };
  254. /**
  255. * Retrieve the current custom time.
  256. * @return {Date} customTime
  257. */
  258. Core.prototype.getCustomTime = function() {
  259. if (!this.customTime) {
  260. throw new Error('Cannot get custom time: Custom time bar is not enabled');
  261. }
  262. return this.customTime.getCustomTime();
  263. };
  264. /**
  265. * Get the id's of the currently visible items.
  266. * @returns {Array} The ids of the visible items
  267. */
  268. Core.prototype.getVisibleItems = function() {
  269. return this.itemSet && this.itemSet.getVisibleItems() || [];
  270. };
  271. /**
  272. * Clear the Core. By Default, items, groups and options are cleared.
  273. * Example usage:
  274. *
  275. * timeline.clear(); // clear items, groups, and options
  276. * timeline.clear({options: true}); // clear options only
  277. *
  278. * @param {Object} [what] Optionally specify what to clear. By default:
  279. * {items: true, groups: true, options: true}
  280. */
  281. Core.prototype.clear = function(what) {
  282. // clear items
  283. if (!what || what.items) {
  284. this.setItems(null);
  285. }
  286. // clear groups
  287. if (!what || what.groups) {
  288. this.setGroups(null);
  289. }
  290. // clear options of timeline and of each of the components
  291. if (!what || what.options) {
  292. this.components.forEach(component => component.setOptions(component.defaultOptions));
  293. this.setOptions(this.defaultOptions); // this will also do a redraw
  294. }
  295. };
  296. /**
  297. * Set Core window such that it fits all items
  298. * @param {Object} [options] Available options:
  299. * `animate: boolean | number`
  300. * If true (default), the range is animated
  301. * smoothly to the new window.
  302. * If a number, the number is taken as duration
  303. * for the animation. Default duration is 500 ms.
  304. */
  305. Core.prototype.fit = function(options) {
  306. var range = this._getDataRange();
  307. // skip range set if there is no start and end date
  308. if (range.start === null && range.end === null) {
  309. return;
  310. }
  311. var animate = (options && options.animate !== undefined) ? options.animate : true;
  312. this.range.setRange(range.start, range.end, animate);
  313. };
  314. /**
  315. * Calculate the data range of the items and applies a 5% window around it.
  316. * @returns {{start: Date | null, end: Date | null}}
  317. * @protected
  318. */
  319. Core.prototype._getDataRange = function() {
  320. // apply the data range as range
  321. var dataRange = this.getItemRange();
  322. // add 5% space on both sides
  323. var start = dataRange.min;
  324. var end = dataRange.max;
  325. if (start != null && end != null) {
  326. var interval = (end.valueOf() - start.valueOf());
  327. if (interval <= 0) {
  328. // prevent an empty interval
  329. interval = 24 * 60 * 60 * 1000; // 1 day
  330. }
  331. start = new Date(start.valueOf() - interval * 0.05);
  332. end = new Date(end.valueOf() + interval * 0.05);
  333. }
  334. return {
  335. start: start,
  336. end: end
  337. }
  338. };
  339. /**
  340. * Set the visible window. Both parameters are optional, you can change only
  341. * start or only end. Syntax:
  342. *
  343. * TimeLine.setWindow(start, end)
  344. * TimeLine.setWindow(start, end, options)
  345. * TimeLine.setWindow(range)
  346. *
  347. * Where start and end can be a Date, number, or string, and range is an
  348. * object with properties start and end.
  349. *
  350. * @param {Date | Number | String | Object} [start] Start date of visible window
  351. * @param {Date | Number | String} [end] End date of visible window
  352. * @param {Object} [options] Available options:
  353. * `animate: boolean | number`
  354. * If true (default), the range is animated
  355. * smoothly to the new window.
  356. * If a number, the number is taken as duration
  357. * for the animation. Default duration is 500 ms.
  358. */
  359. Core.prototype.setWindow = function(start, end, options) {
  360. var animate;
  361. if (arguments.length == 1) {
  362. var range = arguments[0];
  363. animate = (range.animate !== undefined) ? range.animate : true;
  364. this.range.setRange(range.start, range.end, animate);
  365. }
  366. else {
  367. animate = (options && options.animate !== undefined) ? options.animate : true;
  368. this.range.setRange(start, end, animate);
  369. }
  370. };
  371. /**
  372. * Move the window such that given time is centered on screen.
  373. * @param {Date | Number | String} time
  374. * @param {Object} [options] Available options:
  375. * `animate: boolean | number`
  376. * If true (default), the range is animated
  377. * smoothly to the new window.
  378. * If a number, the number is taken as duration
  379. * for the animation. Default duration is 500 ms.
  380. */
  381. Core.prototype.moveTo = function(time, options) {
  382. var interval = this.range.end - this.range.start;
  383. var t = util.convert(time, 'Date').valueOf();
  384. var start = t - interval / 2;
  385. var end = t + interval / 2;
  386. var animate = (options && options.animate !== undefined) ? options.animate : true;
  387. this.range.setRange(start, end, animate);
  388. };
  389. /**
  390. * Get the visible window
  391. * @return {{start: Date, end: Date}} Visible range
  392. */
  393. Core.prototype.getWindow = function() {
  394. var range = this.range.getRange();
  395. return {
  396. start: new Date(range.start),
  397. end: new Date(range.end)
  398. };
  399. };
  400. /**
  401. * Force a redraw. Can be overridden by implementations of Core
  402. */
  403. Core.prototype.redraw = function() {
  404. this._redraw();
  405. };
  406. /**
  407. * Redraw for internal use. Redraws all components. See also the public
  408. * method redraw.
  409. * @protected
  410. */
  411. Core.prototype._redraw = function() {
  412. var resized = false;
  413. var options = this.options;
  414. var props = this.props;
  415. var dom = this.dom;
  416. if (!dom) return; // when destroyed
  417. DateUtil.updateHiddenDates(this.body, this.options.hiddenDates);
  418. // update class names
  419. if (options.orientation == 'top') {
  420. util.addClassName(dom.root, 'top');
  421. util.removeClassName(dom.root, 'bottom');
  422. }
  423. else {
  424. util.removeClassName(dom.root, 'top');
  425. util.addClassName(dom.root, 'bottom');
  426. }
  427. // update root width and height options
  428. dom.root.style.maxHeight = util.option.asSize(options.maxHeight, '');
  429. dom.root.style.minHeight = util.option.asSize(options.minHeight, '');
  430. dom.root.style.width = util.option.asSize(options.width, '');
  431. // calculate border widths
  432. props.border.left = (dom.centerContainer.offsetWidth - dom.centerContainer.clientWidth) / 2;
  433. props.border.right = props.border.left;
  434. props.border.top = (dom.centerContainer.offsetHeight - dom.centerContainer.clientHeight) / 2;
  435. props.border.bottom = props.border.top;
  436. var borderRootHeight= dom.root.offsetHeight - dom.root.clientHeight;
  437. var borderRootWidth = dom.root.offsetWidth - dom.root.clientWidth;
  438. // workaround for a bug in IE: the clientWidth of an element with
  439. // a height:0px and overflow:hidden is not calculated and always has value 0
  440. if (dom.centerContainer.clientHeight === 0) {
  441. props.border.left = props.border.top;
  442. props.border.right = props.border.left;
  443. }
  444. if (dom.root.clientHeight === 0) {
  445. borderRootWidth = borderRootHeight;
  446. }
  447. // calculate the heights. If any of the side panels is empty, we set the height to
  448. // minus the border width, such that the border will be invisible
  449. props.center.height = dom.center.offsetHeight;
  450. props.left.height = dom.left.offsetHeight;
  451. props.right.height = dom.right.offsetHeight;
  452. props.top.height = dom.top.clientHeight || -props.border.top;
  453. props.bottom.height = dom.bottom.clientHeight || -props.border.bottom;
  454. // TODO: compensate borders when any of the panels is empty.
  455. // apply auto height
  456. // TODO: only calculate autoHeight when needed (else we cause an extra reflow/repaint of the DOM)
  457. var contentHeight = Math.max(props.left.height, props.center.height, props.right.height);
  458. var autoHeight = props.top.height + contentHeight + props.bottom.height +
  459. borderRootHeight + props.border.top + props.border.bottom;
  460. dom.root.style.height = util.option.asSize(options.height, autoHeight + 'px');
  461. // calculate heights of the content panels
  462. props.root.height = dom.root.offsetHeight;
  463. props.background.height = props.root.height - borderRootHeight;
  464. var containerHeight = props.root.height - props.top.height - props.bottom.height -
  465. borderRootHeight;
  466. props.centerContainer.height = containerHeight;
  467. props.leftContainer.height = containerHeight;
  468. props.rightContainer.height = props.leftContainer.height;
  469. // calculate the widths of the panels
  470. props.root.width = dom.root.offsetWidth;
  471. props.background.width = props.root.width - borderRootWidth;
  472. props.left.width = dom.leftContainer.clientWidth || -props.border.left;
  473. props.leftContainer.width = props.left.width;
  474. props.right.width = dom.rightContainer.clientWidth || -props.border.right;
  475. props.rightContainer.width = props.right.width;
  476. var centerWidth = props.root.width - props.left.width - props.right.width - borderRootWidth;
  477. props.center.width = centerWidth;
  478. props.centerContainer.width = centerWidth;
  479. props.top.width = centerWidth;
  480. props.bottom.width = centerWidth;
  481. // resize the panels
  482. dom.background.style.height = props.background.height + 'px';
  483. dom.backgroundVertical.style.height = props.background.height + 'px';
  484. dom.backgroundHorizontal.style.height = props.centerContainer.height + 'px';
  485. dom.centerContainer.style.height = props.centerContainer.height + 'px';
  486. dom.leftContainer.style.height = props.leftContainer.height + 'px';
  487. dom.rightContainer.style.height = props.rightContainer.height + 'px';
  488. dom.background.style.width = props.background.width + 'px';
  489. dom.backgroundVertical.style.width = props.centerContainer.width + 'px';
  490. dom.backgroundHorizontal.style.width = props.background.width + 'px';
  491. dom.centerContainer.style.width = props.center.width + 'px';
  492. dom.top.style.width = props.top.width + 'px';
  493. dom.bottom.style.width = props.bottom.width + 'px';
  494. // reposition the panels
  495. dom.background.style.left = '0';
  496. dom.background.style.top = '0';
  497. dom.backgroundVertical.style.left = (props.left.width + props.border.left) + 'px';
  498. dom.backgroundVertical.style.top = '0';
  499. dom.backgroundHorizontal.style.left = '0';
  500. dom.backgroundHorizontal.style.top = props.top.height + 'px';
  501. dom.centerContainer.style.left = props.left.width + 'px';
  502. dom.centerContainer.style.top = props.top.height + 'px';
  503. dom.leftContainer.style.left = '0';
  504. dom.leftContainer.style.top = props.top.height + 'px';
  505. dom.rightContainer.style.left = (props.left.width + props.center.width) + 'px';
  506. dom.rightContainer.style.top = props.top.height + 'px';
  507. dom.top.style.left = props.left.width + 'px';
  508. dom.top.style.top = '0';
  509. dom.bottom.style.left = props.left.width + 'px';
  510. dom.bottom.style.top = (props.top.height + props.centerContainer.height) + 'px';
  511. // update the scrollTop, feasible range for the offset can be changed
  512. // when the height of the Core or of the contents of the center changed
  513. this._updateScrollTop();
  514. // reposition the scrollable contents
  515. var offset = this.props.scrollTop;
  516. if (options.orientation == 'bottom') {
  517. offset += Math.max(this.props.centerContainer.height - this.props.center.height -
  518. this.props.border.top - this.props.border.bottom, 0);
  519. }
  520. dom.center.style.left = '0';
  521. dom.center.style.top = offset + 'px';
  522. dom.left.style.left = '0';
  523. dom.left.style.top = offset + 'px';
  524. dom.right.style.left = '0';
  525. dom.right.style.top = offset + 'px';
  526. // show shadows when vertical scrolling is available
  527. var visibilityTop = this.props.scrollTop == 0 ? 'hidden' : '';
  528. var visibilityBottom = this.props.scrollTop == this.props.scrollTopMin ? 'hidden' : '';
  529. dom.shadowTop.style.visibility = visibilityTop;
  530. dom.shadowBottom.style.visibility = visibilityBottom;
  531. dom.shadowTopLeft.style.visibility = visibilityTop;
  532. dom.shadowBottomLeft.style.visibility = visibilityBottom;
  533. dom.shadowTopRight.style.visibility = visibilityTop;
  534. dom.shadowBottomRight.style.visibility = visibilityBottom;
  535. // redraw all components
  536. this.components.forEach(function (component) {
  537. resized = component.redraw() || resized;
  538. });
  539. if (resized) {
  540. // keep repainting until all sizes are settled
  541. var MAX_REDRAWS = 3; // maximum number of consecutive redraws
  542. if (this.redrawCount < MAX_REDRAWS) {
  543. this.redrawCount++;
  544. this._redraw();
  545. }
  546. else {
  547. console.log('WARNING: infinite loop in redraw?');
  548. }
  549. this.redrawCount = 0;
  550. }
  551. this.emit("finishedRedraw");
  552. };
  553. // TODO: deprecated since version 1.1.0, remove some day
  554. Core.prototype.repaint = function () {
  555. throw new Error('Function repaint is deprecated. Use redraw instead.');
  556. };
  557. /**
  558. * Set a current time. This can be used for example to ensure that a client's
  559. * time is synchronized with a shared server time.
  560. * Only applicable when option `showCurrentTime` is true.
  561. * @param {Date | String | Number} time A Date, unix timestamp, or
  562. * ISO date string.
  563. */
  564. Core.prototype.setCurrentTime = function(time) {
  565. if (!this.currentTime) {
  566. throw new Error('Option showCurrentTime must be true');
  567. }
  568. this.currentTime.setCurrentTime(time);
  569. };
  570. /**
  571. * Get the current time.
  572. * Only applicable when option `showCurrentTime` is true.
  573. * @return {Date} Returns the current time.
  574. */
  575. Core.prototype.getCurrentTime = function() {
  576. if (!this.currentTime) {
  577. throw new Error('Option showCurrentTime must be true');
  578. }
  579. return this.currentTime.getCurrentTime();
  580. };
  581. /**
  582. * Convert a position on screen (pixels) to a datetime
  583. * @param {int} x Position on the screen in pixels
  584. * @return {Date} time The datetime the corresponds with given position x
  585. * @private
  586. */
  587. // TODO: move this function to Range
  588. Core.prototype._toTime = function(x) {
  589. return DateUtil.toTime(this, x, this.props.center.width);
  590. };
  591. /**
  592. * Convert a position on the global screen (pixels) to a datetime
  593. * @param {int} x Position on the screen in pixels
  594. * @return {Date} time The datetime the corresponds with given position x
  595. * @private
  596. */
  597. // TODO: move this function to Range
  598. Core.prototype._toGlobalTime = function(x) {
  599. return DateUtil.toTime(this, x, this.props.root.width);
  600. //var conversion = this.range.conversion(this.props.root.width);
  601. //return new Date(x / conversion.scale + conversion.offset);
  602. };
  603. /**
  604. * Convert a datetime (Date object) into a position on the screen
  605. * @param {Date} time A date
  606. * @return {int} x The position on the screen in pixels which corresponds
  607. * with the given date.
  608. * @private
  609. */
  610. // TODO: move this function to Range
  611. Core.prototype._toScreen = function(time) {
  612. return DateUtil.toScreen(this, time, this.props.center.width);
  613. };
  614. /**
  615. * Convert a datetime (Date object) into a position on the root
  616. * This is used to get the pixel density estimate for the screen, not the center panel
  617. * @param {Date} time A date
  618. * @return {int} x The position on root in pixels which corresponds
  619. * with the given date.
  620. * @private
  621. */
  622. // TODO: move this function to Range
  623. Core.prototype._toGlobalScreen = function(time) {
  624. return DateUtil.toScreen(this, time, this.props.root.width);
  625. //var conversion = this.range.conversion(this.props.root.width);
  626. //return (time.valueOf() - conversion.offset) * conversion.scale;
  627. };
  628. /**
  629. * Initialize watching when option autoResize is true
  630. * @private
  631. */
  632. Core.prototype._initAutoResize = function () {
  633. if (this.options.autoResize == true) {
  634. this._startAutoResize();
  635. }
  636. else {
  637. this._stopAutoResize();
  638. }
  639. };
  640. /**
  641. * Watch for changes in the size of the container. On resize, the Panel will
  642. * automatically redraw itself.
  643. * @private
  644. */
  645. Core.prototype._startAutoResize = function () {
  646. var me = this;
  647. this._stopAutoResize();
  648. this._onResize = function() {
  649. if (me.options.autoResize != true) {
  650. // stop watching when the option autoResize is changed to false
  651. me._stopAutoResize();
  652. return;
  653. }
  654. if (me.dom.root) {
  655. // check whether the frame is resized
  656. // Note: we compare offsetWidth here, not clientWidth. For some reason,
  657. // IE does not restore the clientWidth from 0 to the actual width after
  658. // changing the timeline's container display style from none to visible
  659. if ((me.dom.root.offsetWidth != me.props.lastWidth) ||
  660. (me.dom.root.offsetHeight != me.props.lastHeight)) {
  661. me.props.lastWidth = me.dom.root.offsetWidth;
  662. me.props.lastHeight = me.dom.root.offsetHeight;
  663. me.emit('change');
  664. }
  665. }
  666. };
  667. // add event listener to window resize
  668. util.addEventListener(window, 'resize', this._onResize);
  669. this.watchTimer = setInterval(this._onResize, 1000);
  670. };
  671. /**
  672. * Stop watching for a resize of the frame.
  673. * @private
  674. */
  675. Core.prototype._stopAutoResize = function () {
  676. if (this.watchTimer) {
  677. clearInterval(this.watchTimer);
  678. this.watchTimer = undefined;
  679. }
  680. // remove event listener on window.resize
  681. util.removeEventListener(window, 'resize', this._onResize);
  682. this._onResize = null;
  683. };
  684. /**
  685. * Start moving the timeline vertically
  686. * @param {Event} event
  687. * @private
  688. */
  689. Core.prototype._onTouch = function (event) {
  690. this.touch.allowDragging = true;
  691. };
  692. /**
  693. * Start moving the timeline vertically
  694. * @param {Event} event
  695. * @private
  696. */
  697. Core.prototype._onPinch = function (event) {
  698. this.touch.allowDragging = false;
  699. };
  700. /**
  701. * Start moving the timeline vertically
  702. * @param {Event} event
  703. * @private
  704. */
  705. Core.prototype._onDragStart = function (event) {
  706. this.touch.initialScrollTop = this.props.scrollTop;
  707. };
  708. /**
  709. * Move the timeline vertically
  710. * @param {Event} event
  711. * @private
  712. */
  713. Core.prototype._onDrag = function (event) {
  714. // refuse to drag when we where pinching to prevent the timeline make a jump
  715. // when releasing the fingers in opposite order from the touch screen
  716. if (!this.touch.allowDragging) return;
  717. var delta = event.gesture.deltaY;
  718. var oldScrollTop = this._getScrollTop();
  719. var newScrollTop = this._setScrollTop(this.touch.initialScrollTop + delta);
  720. if (newScrollTop != oldScrollTop) {
  721. this._redraw(); // TODO: this causes two redraws when dragging, the other is triggered by rangechange already
  722. this.emit("verticalDrag");
  723. }
  724. };
  725. /**
  726. * Apply a scrollTop
  727. * @param {Number} scrollTop
  728. * @returns {Number} scrollTop Returns the applied scrollTop
  729. * @private
  730. */
  731. Core.prototype._setScrollTop = function (scrollTop) {
  732. this.props.scrollTop = scrollTop;
  733. this._updateScrollTop();
  734. return this.props.scrollTop;
  735. };
  736. /**
  737. * Update the current scrollTop when the height of the containers has been changed
  738. * @returns {Number} scrollTop Returns the applied scrollTop
  739. * @private
  740. */
  741. Core.prototype._updateScrollTop = function () {
  742. // recalculate the scrollTopMin
  743. var scrollTopMin = Math.min(this.props.centerContainer.height - this.props.center.height, 0); // is negative or zero
  744. if (scrollTopMin != this.props.scrollTopMin) {
  745. // in case of bottom orientation, change the scrollTop such that the contents
  746. // do not move relative to the time axis at the bottom
  747. if (this.options.orientation == 'bottom') {
  748. this.props.scrollTop += (scrollTopMin - this.props.scrollTopMin);
  749. }
  750. this.props.scrollTopMin = scrollTopMin;
  751. }
  752. // limit the scrollTop to the feasible scroll range
  753. if (this.props.scrollTop > 0) this.props.scrollTop = 0;
  754. if (this.props.scrollTop < scrollTopMin) this.props.scrollTop = scrollTopMin;
  755. return this.props.scrollTop;
  756. };
  757. /**
  758. * Get the current scrollTop
  759. * @returns {number} scrollTop
  760. * @private
  761. */
  762. Core.prototype._getScrollTop = function () {
  763. return this.props.scrollTop;
  764. };
  765. module.exports = Core;