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.

856 lines
29 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. this.activator = new Activator(this.dom.root);
  183. }
  184. else {
  185. if (this.activator) {
  186. this.activator.destroy();
  187. delete this.activator;
  188. }
  189. }
  190. }
  191. // enable/disable autoResize
  192. this._initAutoResize();
  193. }
  194. // propagate options to all components
  195. this.components.forEach(function (component) {
  196. component.setOptions(options);
  197. });
  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(function (component) {
  242. component.destroy();
  243. });
  244. this.body = null;
  245. };
  246. /**
  247. * Set a custom time bar
  248. * @param {Date} time
  249. */
  250. Core.prototype.setCustomTime = function (time) {
  251. if (!this.customTime) {
  252. throw new Error('Cannot get custom time: Custom time bar is not enabled');
  253. }
  254. this.customTime.setCustomTime(time);
  255. };
  256. /**
  257. * Retrieve the current custom time.
  258. * @return {Date} customTime
  259. */
  260. Core.prototype.getCustomTime = function() {
  261. if (!this.customTime) {
  262. throw new Error('Cannot get custom time: Custom time bar is not enabled');
  263. }
  264. return this.customTime.getCustomTime();
  265. };
  266. /**
  267. * Get the id's of the currently visible items.
  268. * @returns {Array} The ids of the visible items
  269. */
  270. Core.prototype.getVisibleItems = function() {
  271. return this.itemSet && this.itemSet.getVisibleItems() || [];
  272. };
  273. /**
  274. * Clear the Core. By Default, items, groups and options are cleared.
  275. * Example usage:
  276. *
  277. * timeline.clear(); // clear items, groups, and options
  278. * timeline.clear({options: true}); // clear options only
  279. *
  280. * @param {Object} [what] Optionally specify what to clear. By default:
  281. * {items: true, groups: true, options: true}
  282. */
  283. Core.prototype.clear = function(what) {
  284. // clear items
  285. if (!what || what.items) {
  286. this.setItems(null);
  287. }
  288. // clear groups
  289. if (!what || what.groups) {
  290. this.setGroups(null);
  291. }
  292. // clear options of timeline and of each of the components
  293. if (!what || what.options) {
  294. this.components.forEach(function (component) {
  295. component.setOptions(component.defaultOptions);
  296. });
  297. this.setOptions(this.defaultOptions); // this will also do a redraw
  298. }
  299. };
  300. /**
  301. * Set Core window such that it fits all items
  302. * @param {Object} [options] Available options:
  303. * `animate: boolean | number`
  304. * If true (default), the range is animated
  305. * smoothly to the new window.
  306. * If a number, the number is taken as duration
  307. * for the animation. Default duration is 500 ms.
  308. */
  309. Core.prototype.fit = function(options) {
  310. // apply the data range as range
  311. var dataRange = this.getItemRange();
  312. // add 5% space on both sides
  313. var start = dataRange.min;
  314. var end = dataRange.max;
  315. if (start != null && end != null) {
  316. var interval = (end.valueOf() - start.valueOf());
  317. if (interval <= 0) {
  318. // prevent an empty interval
  319. interval = 24 * 60 * 60 * 1000; // 1 day
  320. }
  321. start = new Date(start.valueOf() - interval * 0.05);
  322. end = new Date(end.valueOf() + interval * 0.05);
  323. }
  324. // skip range set if there is no start and end date
  325. if (start === null && end === null) {
  326. return;
  327. }
  328. var animate = (options && options.animate !== undefined) ? options.animate : true;
  329. this.range.setRange(start, end, animate);
  330. };
  331. /**
  332. * Set the visible window. Both parameters are optional, you can change only
  333. * start or only end. Syntax:
  334. *
  335. * TimeLine.setWindow(start, end)
  336. * TimeLine.setWindow(range)
  337. *
  338. * Where start and end can be a Date, number, or string, and range is an
  339. * object with properties start and end.
  340. *
  341. * @param {Date | Number | String | Object} [start] Start date of visible window
  342. * @param {Date | Number | String} [end] End date of visible window
  343. * @param {Object} [options] Available options:
  344. * `animate: boolean | number`
  345. * If true (default), the range is animated
  346. * smoothly to the new window.
  347. * If a number, the number is taken as duration
  348. * for the animation. Default duration is 500 ms.
  349. */
  350. Core.prototype.setWindow = function(start, end, options) {
  351. var animate = (options && options.animate !== undefined) ? options.animate : true;
  352. if (arguments.length == 1) {
  353. var range = arguments[0];
  354. this.range.setRange(range.start, range.end, animate);
  355. }
  356. else {
  357. this.range.setRange(start, end, animate);
  358. }
  359. };
  360. /**
  361. * Move the window such that given time is centered on screen.
  362. * @param {Date | Number | String} time
  363. * @param {Object} [options] Available options:
  364. * `animate: boolean | number`
  365. * If true (default), the range is animated
  366. * smoothly to the new window.
  367. * If a number, the number is taken as duration
  368. * for the animation. Default duration is 500 ms.
  369. */
  370. Core.prototype.moveTo = function(time, options) {
  371. var interval = this.range.end - this.range.start;
  372. var t = util.convert(time, 'Date').valueOf();
  373. var start = t - interval / 2;
  374. var end = t + interval / 2;
  375. var animate = (options && options.animate !== undefined) ? options.animate : true;
  376. this.range.setRange(start, end, animate);
  377. };
  378. /**
  379. * Get the visible window
  380. * @return {{start: Date, end: Date}} Visible range
  381. */
  382. Core.prototype.getWindow = function() {
  383. var range = this.range.getRange();
  384. return {
  385. start: new Date(range.start),
  386. end: new Date(range.end)
  387. };
  388. };
  389. /**
  390. * Force a redraw of the Core. Can be useful to manually redraw when
  391. * option autoResize=false
  392. */
  393. Core.prototype.redraw = function() {
  394. var resized = false;
  395. var options = this.options;
  396. var props = this.props;
  397. var dom = this.dom;
  398. if (!dom) return; // when destroyed
  399. DateUtil.updateHiddenDates(this.body, this.options.hiddenDates);
  400. // update class names
  401. if (options.orientation == 'top') {
  402. util.addClassName(dom.root, 'top');
  403. util.removeClassName(dom.root, 'bottom');
  404. }
  405. else {
  406. util.removeClassName(dom.root, 'top');
  407. util.addClassName(dom.root, 'bottom');
  408. }
  409. // update root width and height options
  410. dom.root.style.maxHeight = util.option.asSize(options.maxHeight, '');
  411. dom.root.style.minHeight = util.option.asSize(options.minHeight, '');
  412. dom.root.style.width = util.option.asSize(options.width, '');
  413. // calculate border widths
  414. props.border.left = (dom.centerContainer.offsetWidth - dom.centerContainer.clientWidth) / 2;
  415. props.border.right = props.border.left;
  416. props.border.top = (dom.centerContainer.offsetHeight - dom.centerContainer.clientHeight) / 2;
  417. props.border.bottom = props.border.top;
  418. var borderRootHeight= dom.root.offsetHeight - dom.root.clientHeight;
  419. var borderRootWidth = dom.root.offsetWidth - dom.root.clientWidth;
  420. // workaround for a bug in IE: the clientWidth of an element with
  421. // a height:0px and overflow:hidden is not calculated and always has value 0
  422. if (dom.centerContainer.clientHeight === 0) {
  423. props.border.left = props.border.top;
  424. props.border.right = props.border.left;
  425. }
  426. if (dom.root.clientHeight === 0) {
  427. borderRootWidth = borderRootHeight;
  428. }
  429. // calculate the heights. If any of the side panels is empty, we set the height to
  430. // minus the border width, such that the border will be invisible
  431. props.center.height = dom.center.offsetHeight;
  432. props.left.height = dom.left.offsetHeight;
  433. props.right.height = dom.right.offsetHeight;
  434. props.top.height = dom.top.clientHeight || -props.border.top;
  435. props.bottom.height = dom.bottom.clientHeight || -props.border.bottom;
  436. // TODO: compensate borders when any of the panels is empty.
  437. // apply auto height
  438. // TODO: only calculate autoHeight when needed (else we cause an extra reflow/repaint of the DOM)
  439. var contentHeight = Math.max(props.left.height, props.center.height, props.right.height);
  440. var autoHeight = props.top.height + contentHeight + props.bottom.height +
  441. borderRootHeight + props.border.top + props.border.bottom;
  442. dom.root.style.height = util.option.asSize(options.height, autoHeight + 'px');
  443. // calculate heights of the content panels
  444. props.root.height = dom.root.offsetHeight;
  445. props.background.height = props.root.height - borderRootHeight;
  446. var containerHeight = props.root.height - props.top.height - props.bottom.height -
  447. borderRootHeight;
  448. props.centerContainer.height = containerHeight;
  449. props.leftContainer.height = containerHeight;
  450. props.rightContainer.height = props.leftContainer.height;
  451. // calculate the widths of the panels
  452. props.root.width = dom.root.offsetWidth;
  453. props.background.width = props.root.width - borderRootWidth;
  454. props.left.width = dom.leftContainer.clientWidth || -props.border.left;
  455. props.leftContainer.width = props.left.width;
  456. props.right.width = dom.rightContainer.clientWidth || -props.border.right;
  457. props.rightContainer.width = props.right.width;
  458. var centerWidth = props.root.width - props.left.width - props.right.width - borderRootWidth;
  459. props.center.width = centerWidth;
  460. props.centerContainer.width = centerWidth;
  461. props.top.width = centerWidth;
  462. props.bottom.width = centerWidth;
  463. // resize the panels
  464. dom.background.style.height = props.background.height + 'px';
  465. dom.backgroundVertical.style.height = props.background.height + 'px';
  466. dom.backgroundHorizontal.style.height = props.centerContainer.height + 'px';
  467. dom.centerContainer.style.height = props.centerContainer.height + 'px';
  468. dom.leftContainer.style.height = props.leftContainer.height + 'px';
  469. dom.rightContainer.style.height = props.rightContainer.height + 'px';
  470. dom.background.style.width = props.background.width + 'px';
  471. dom.backgroundVertical.style.width = props.centerContainer.width + 'px';
  472. dom.backgroundHorizontal.style.width = props.background.width + 'px';
  473. dom.centerContainer.style.width = props.center.width + 'px';
  474. dom.top.style.width = props.top.width + 'px';
  475. dom.bottom.style.width = props.bottom.width + 'px';
  476. // reposition the panels
  477. dom.background.style.left = '0';
  478. dom.background.style.top = '0';
  479. dom.backgroundVertical.style.left = (props.left.width + props.border.left) + 'px';
  480. dom.backgroundVertical.style.top = '0';
  481. dom.backgroundHorizontal.style.left = '0';
  482. dom.backgroundHorizontal.style.top = props.top.height + 'px';
  483. dom.centerContainer.style.left = props.left.width + 'px';
  484. dom.centerContainer.style.top = props.top.height + 'px';
  485. dom.leftContainer.style.left = '0';
  486. dom.leftContainer.style.top = props.top.height + 'px';
  487. dom.rightContainer.style.left = (props.left.width + props.center.width) + 'px';
  488. dom.rightContainer.style.top = props.top.height + 'px';
  489. dom.top.style.left = props.left.width + 'px';
  490. dom.top.style.top = '0';
  491. dom.bottom.style.left = props.left.width + 'px';
  492. dom.bottom.style.top = (props.top.height + props.centerContainer.height) + 'px';
  493. // update the scrollTop, feasible range for the offset can be changed
  494. // when the height of the Core or of the contents of the center changed
  495. this._updateScrollTop();
  496. // reposition the scrollable contents
  497. var offset = this.props.scrollTop;
  498. if (options.orientation == 'bottom') {
  499. offset += Math.max(this.props.centerContainer.height - this.props.center.height -
  500. this.props.border.top - this.props.border.bottom, 0);
  501. }
  502. dom.center.style.left = '0';
  503. dom.center.style.top = offset + 'px';
  504. dom.left.style.left = '0';
  505. dom.left.style.top = offset + 'px';
  506. dom.right.style.left = '0';
  507. dom.right.style.top = offset + 'px';
  508. // show shadows when vertical scrolling is available
  509. var visibilityTop = this.props.scrollTop == 0 ? 'hidden' : '';
  510. var visibilityBottom = this.props.scrollTop == this.props.scrollTopMin ? 'hidden' : '';
  511. dom.shadowTop.style.visibility = visibilityTop;
  512. dom.shadowBottom.style.visibility = visibilityBottom;
  513. dom.shadowTopLeft.style.visibility = visibilityTop;
  514. dom.shadowBottomLeft.style.visibility = visibilityBottom;
  515. dom.shadowTopRight.style.visibility = visibilityTop;
  516. dom.shadowBottomRight.style.visibility = visibilityBottom;
  517. // redraw all components
  518. this.components.forEach(function (component) {
  519. resized = component.redraw() || resized;
  520. });
  521. if (resized) {
  522. // keep repainting until all sizes are settled
  523. var MAX_REDRAWS = 2; // maximum number of consecutive redraws
  524. if (this.redrawCount < MAX_REDRAWS) {
  525. this.redrawCount++;
  526. this.redraw();
  527. }
  528. else {
  529. console.log('WARNING: infinite loop in redraw?')
  530. }
  531. this.redrawCount = 0;
  532. }
  533. this.emit("finishedRedraw");
  534. };
  535. // TODO: deprecated since version 1.1.0, remove some day
  536. Core.prototype.repaint = function () {
  537. throw new Error('Function repaint is deprecated. Use redraw instead.');
  538. };
  539. /**
  540. * Set a current time. This can be used for example to ensure that a client's
  541. * time is synchronized with a shared server time.
  542. * Only applicable when option `showCurrentTime` is true.
  543. * @param {Date | String | Number} time A Date, unix timestamp, or
  544. * ISO date string.
  545. */
  546. Core.prototype.setCurrentTime = function(time) {
  547. if (!this.currentTime) {
  548. throw new Error('Option showCurrentTime must be true');
  549. }
  550. this.currentTime.setCurrentTime(time);
  551. };
  552. /**
  553. * Get the current time.
  554. * Only applicable when option `showCurrentTime` is true.
  555. * @return {Date} Returns the current time.
  556. */
  557. Core.prototype.getCurrentTime = function() {
  558. if (!this.currentTime) {
  559. throw new Error('Option showCurrentTime must be true');
  560. }
  561. return this.currentTime.getCurrentTime();
  562. };
  563. /**
  564. * Convert a position on screen (pixels) to a datetime
  565. * @param {int} x Position on the screen in pixels
  566. * @return {Date} time The datetime the corresponds with given position x
  567. * @private
  568. */
  569. // TODO: move this function to Range
  570. Core.prototype._toTime = function(x) {
  571. return DateUtil.toTime(this, x, this.props.center.width);
  572. };
  573. /**
  574. * Convert a position on the global screen (pixels) to a datetime
  575. * @param {int} x Position on the screen in pixels
  576. * @return {Date} time The datetime the corresponds with given position x
  577. * @private
  578. */
  579. // TODO: move this function to Range
  580. Core.prototype._toGlobalTime = function(x) {
  581. return DateUtil.toTime(this, x, this.props.root.width);
  582. //var conversion = this.range.conversion(this.props.root.width);
  583. //return new Date(x / conversion.scale + conversion.offset);
  584. };
  585. /**
  586. * Convert a datetime (Date object) into a position on the screen
  587. * @param {Date} time A date
  588. * @return {int} x The position on the screen in pixels which corresponds
  589. * with the given date.
  590. * @private
  591. */
  592. // TODO: move this function to Range
  593. Core.prototype._toScreen = function(time) {
  594. return DateUtil.toScreen(this, time, this.props.center.width);
  595. };
  596. /**
  597. * Convert a datetime (Date object) into a position on the root
  598. * This is used to get the pixel density estimate for the screen, not the center panel
  599. * @param {Date} time A date
  600. * @return {int} x The position on root in pixels which corresponds
  601. * with the given date.
  602. * @private
  603. */
  604. // TODO: move this function to Range
  605. Core.prototype._toGlobalScreen = function(time) {
  606. return DateUtil.toScreen(this, time, this.props.root.width);
  607. //var conversion = this.range.conversion(this.props.root.width);
  608. //return (time.valueOf() - conversion.offset) * conversion.scale;
  609. };
  610. /**
  611. * Initialize watching when option autoResize is true
  612. * @private
  613. */
  614. Core.prototype._initAutoResize = function () {
  615. if (this.options.autoResize == true) {
  616. this._startAutoResize();
  617. }
  618. else {
  619. this._stopAutoResize();
  620. }
  621. };
  622. /**
  623. * Watch for changes in the size of the container. On resize, the Panel will
  624. * automatically redraw itself.
  625. * @private
  626. */
  627. Core.prototype._startAutoResize = function () {
  628. var me = this;
  629. this._stopAutoResize();
  630. this._onResize = function() {
  631. if (me.options.autoResize != true) {
  632. // stop watching when the option autoResize is changed to false
  633. me._stopAutoResize();
  634. return;
  635. }
  636. if (me.dom.root) {
  637. // check whether the frame is resized
  638. // Note: we compare offsetWidth here, not clientWidth. For some reason,
  639. // IE does not restore the clientWidth from 0 to the actual width after
  640. // changing the timeline's container display style from none to visible
  641. if ((me.dom.root.offsetWidth != me.props.lastWidth) ||
  642. (me.dom.root.offsetHeight != me.props.lastHeight)) {
  643. me.props.lastWidth = me.dom.root.offsetWidth;
  644. me.props.lastHeight = me.dom.root.offsetHeight;
  645. me.emit('change');
  646. }
  647. }
  648. };
  649. // add event listener to window resize
  650. util.addEventListener(window, 'resize', this._onResize);
  651. this.watchTimer = setInterval(this._onResize, 1000);
  652. };
  653. /**
  654. * Stop watching for a resize of the frame.
  655. * @private
  656. */
  657. Core.prototype._stopAutoResize = function () {
  658. if (this.watchTimer) {
  659. clearInterval(this.watchTimer);
  660. this.watchTimer = undefined;
  661. }
  662. // remove event listener on window.resize
  663. util.removeEventListener(window, 'resize', this._onResize);
  664. this._onResize = null;
  665. };
  666. /**
  667. * Start moving the timeline vertically
  668. * @param {Event} event
  669. * @private
  670. */
  671. Core.prototype._onTouch = function (event) {
  672. this.touch.allowDragging = true;
  673. };
  674. /**
  675. * Start moving the timeline vertically
  676. * @param {Event} event
  677. * @private
  678. */
  679. Core.prototype._onPinch = function (event) {
  680. this.touch.allowDragging = false;
  681. };
  682. /**
  683. * Start moving the timeline vertically
  684. * @param {Event} event
  685. * @private
  686. */
  687. Core.prototype._onDragStart = function (event) {
  688. this.touch.initialScrollTop = this.props.scrollTop;
  689. };
  690. /**
  691. * Move the timeline vertically
  692. * @param {Event} event
  693. * @private
  694. */
  695. Core.prototype._onDrag = function (event) {
  696. // refuse to drag when we where pinching to prevent the timeline make a jump
  697. // when releasing the fingers in opposite order from the touch screen
  698. if (!this.touch.allowDragging) return;
  699. var delta = event.gesture.deltaY;
  700. var oldScrollTop = this._getScrollTop();
  701. var newScrollTop = this._setScrollTop(this.touch.initialScrollTop + delta);
  702. if (newScrollTop != oldScrollTop) {
  703. this.redraw(); // TODO: this causes two redraws when dragging, the other is triggered by rangechange already
  704. this.emit("verticalDrag");
  705. }
  706. };
  707. /**
  708. * Apply a scrollTop
  709. * @param {Number} scrollTop
  710. * @returns {Number} scrollTop Returns the applied scrollTop
  711. * @private
  712. */
  713. Core.prototype._setScrollTop = function (scrollTop) {
  714. this.props.scrollTop = scrollTop;
  715. this._updateScrollTop();
  716. return this.props.scrollTop;
  717. };
  718. /**
  719. * Update the current scrollTop when the height of the containers has been changed
  720. * @returns {Number} scrollTop Returns the applied scrollTop
  721. * @private
  722. */
  723. Core.prototype._updateScrollTop = function () {
  724. // recalculate the scrollTopMin
  725. var scrollTopMin = Math.min(this.props.centerContainer.height - this.props.center.height, 0); // is negative or zero
  726. if (scrollTopMin != this.props.scrollTopMin) {
  727. // in case of bottom orientation, change the scrollTop such that the contents
  728. // do not move relative to the time axis at the bottom
  729. if (this.options.orientation == 'bottom') {
  730. this.props.scrollTop += (scrollTopMin - this.props.scrollTopMin);
  731. }
  732. this.props.scrollTopMin = scrollTopMin;
  733. }
  734. // limit the scrollTop to the feasible scroll range
  735. if (this.props.scrollTop > 0) this.props.scrollTop = 0;
  736. if (this.props.scrollTop < scrollTopMin) this.props.scrollTop = scrollTopMin;
  737. return this.props.scrollTop;
  738. };
  739. /**
  740. * Get the current scrollTop
  741. * @returns {number} scrollTop
  742. * @private
  743. */
  744. Core.prototype._getScrollTop = function () {
  745. return this.props.scrollTop;
  746. };
  747. module.exports = Core;