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.

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