var Hammer = require('../../../module/hammer'); var Item = require('./Item'); var BackgroundGroup = require('../BackgroundGroup'); var RangeItem = require('./RangeItem'); /** * @constructor BackgroundItem * @extends Item * @param {Object} data Object containing parameters start, end * content, className. * @param {{toScreen: function, toTime: function}} conversion * Conversion functions from time to screen and vice versa * @param {Object} [options] Configuration options * // TODO: describe options */ // TODO: implement support for the BackgroundItem just having a start, then being displayed as a sort of an annotation function BackgroundItem (data, conversion, options) { this.props = { content: { width: 0 } }; this.overflow = false; // if contents can overflow (css styling), this flag is set to true // validate data if (data) { if (data.start == undefined) { throw new Error('Property "start" missing in item ' + data.id); } if (data.end == undefined) { throw new Error('Property "end" missing in item ' + data.id); } } Item.call(this, data, conversion, options); } BackgroundItem.prototype = new Item (null, null, null); BackgroundItem.prototype.baseClassName = 'vis-item vis-background'; BackgroundItem.prototype.stack = false; /** * Check whether this item is visible inside given range * @returns {{start: Number, end: Number}} range with a timestamp for start and end * @returns {boolean} True if visible */ BackgroundItem.prototype.isVisible = function(range) { // determine visibility return (this.data.start < range.end) && (this.data.end > range.start); }; /** * Repaint the item */ BackgroundItem.prototype.redraw = function() { var dom = this.dom; if (!dom) { // create DOM this.dom = {}; dom = this.dom; // background box dom.box = document.createElement('div'); // className is updated in redraw() // frame box (to prevent the item contents from overflowing dom.frame = document.createElement('div'); dom.frame.className = 'vis-item-frame'; dom.box.appendChild(dom.frame); // contents box dom.content = document.createElement('div'); dom.content.className = 'vis-item-content'; dom.frame.appendChild(dom.content); // Note: we do NOT attach this item as attribute to the DOM, // such that background items cannot be selected //dom.box['timeline-item'] = this; this.dirty = true; } // append DOM to parent DOM if (!this.parent) { throw new Error('Cannot redraw item: no parent attached'); } if (!dom.box.parentNode) { var background = this.parent.dom.background; if (!background) { throw new Error('Cannot redraw item: parent has no background container element'); } background.appendChild(dom.box); } this.displayed = true; // Update DOM when item is marked dirty. An item is marked dirty when: // - the item is not yet rendered // - the item's data is changed // - the item is selected/deselected if (this.dirty) { this._updateContents(this.dom.content); this._updateTitle(this.dom.content); this._updateDataAttributes(this.dom.content); this._updateStyle(this.dom.box); // update class var className = (this.data.className ? (' ' + this.data.className) : '') + (this.selected ? ' vis-selected' : ''); dom.box.className = this.baseClassName + className; // determine from css whether this box has overflow this.overflow = window.getComputedStyle(dom.content).overflow !== 'hidden'; // recalculate size this.props.content.width = this.dom.content.offsetWidth; this.height = 0; // set height zero, so this item will be ignored when stacking items this.dirty = false; } }; /** * Show the item in the DOM (when not already visible). The items DOM will * be created when needed. */ BackgroundItem.prototype.show = RangeItem.prototype.show; /** * Hide the item from the DOM (when visible) * @return {Boolean} changed */ BackgroundItem.prototype.hide = RangeItem.prototype.hide; /** * Reposition the item horizontally * @Override */ BackgroundItem.prototype.repositionX = RangeItem.prototype.repositionX; /** * Reposition the item vertically * @Override */ BackgroundItem.prototype.repositionY = function(margin) { var onTop = this.options.orientation === 'top'; this.dom.content.style.top = onTop ? '' : '0'; this.dom.content.style.bottom = onTop ? '0' : ''; var height; // special positioning for subgroups if (this.data.subgroup !== undefined) { // TODO: instead of calculating the top position of the subgroups here for every BackgroundItem, calculate the top of the subgroup once in Itemset var itemSubgroup = this.data.subgroup; var subgroups = this.parent.subgroups; var subgroupIndex = subgroups[itemSubgroup].index; // if the orientation is top, we need to take the difference in height into account. if (onTop == true) { // the first subgroup will have to account for the distance from the top to the first item. height = this.parent.subgroups[itemSubgroup].height + margin.item.vertical; height += subgroupIndex == 0 ? margin.axis - 0.5*margin.item.vertical : 0; var newTop = this.parent.top; for (var subgroup in subgroups) { if (subgroups.hasOwnProperty(subgroup)) { if (subgroups[subgroup].visible == true && subgroups[subgroup].index < subgroupIndex) { newTop += subgroups[subgroup].height + margin.item.vertical; } } } // the others will have to be offset downwards with this same distance. newTop += subgroupIndex != 0 ? margin.axis - 0.5 * margin.item.vertical : 0; this.dom.box.style.top = newTop + 'px'; this.dom.box.style.bottom = ''; } // and when the orientation is bottom: else { var newTop = this.parent.top; var totalHeight = 0; for (var subgroup in subgroups) { if (subgroups.hasOwnProperty(subgroup)) { if (subgroups[subgroup].visible == true) { var newHeight = subgroups[subgroup].height + margin.item.vertical; totalHeight += newHeight; if (subgroups[subgroup].index > subgroupIndex) { newTop += newHeight; } } } } height = this.parent.subgroups[itemSubgroup].height + margin.item.vertical; this.dom.box.style.top = (this.parent.height - totalHeight + newTop) + 'px'; this.dom.box.style.bottom = ''; } } // and in the case of no subgroups: else { // we want backgrounds with groups to only show in groups. if (this.parent instanceof BackgroundGroup) { // if the item is not in a group: height = Math.max(this.parent.height, this.parent.itemSet.body.domProps.center.height, this.parent.itemSet.body.domProps.centerContainer.height); this.dom.box.style.top = onTop ? '0' : ''; this.dom.box.style.bottom = onTop ? '' : '0'; } else { height = this.parent.height; // same alignment for items when orientation is top or bottom this.dom.box.style.top = this.parent.top + 'px'; this.dom.box.style.bottom = ''; } } this.dom.box.style.height = height + 'px'; }; module.exports = BackgroundItem;