Class Index | File Index

Classes


Class links.Timeline.ItemBox


Extends links.Timeline.Item.

Defined in: timeline.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
links.Timeline.ItemBox(data, options)
Method Summary
Method Attributes Method Name and Description
 
Creates the DOM for the item, depending on its type
 
getLeft(timeline)
Calculate the left position of the item
 
getRight(timeline)
Calculate the right position of the item
 
Remove the items DOM from the current HTML container, but keep the DOM in memory
 
isVisible(start, end)
Check if the item is visible in the timeline, and not part of a cluster
 
Reflow the Item: retrieve its actual size from the DOM
 
Select the item
 
setPosition(left, right)
Reposition the item
 
showDOM(container)
Append the items DOM to the given HTML container.
 
Unselect the item
 
Update the DOM of the item.
 
updatePosition(timeline)
Reposition the item, recalculate its left, top, and width, using the current range of the timeline and the timeline options.
Methods borrowed from class links.Timeline.Item:
getImageUrls, getWidth, isRendered
Class Detail
links.Timeline.ItemBox(data, options)
Parameters:
{Object} data
Object containing parameters start, end content, group, type, className, editable.
{Object} options Optional
Options to set initial property values {Number} top {Number} left {Number} width {Number} height
Method Detail
{Element | undefined} createDOM()
Creates the DOM for the item, depending on its type
Returns:
{Element | undefined}

{Number} getLeft(timeline)
Calculate the left position of the item
Parameters:
{links.Timeline} timeline
Returns:
{Number} left

{Number} getRight(timeline)
Calculate the right position of the item
Parameters:
{links.Timeline} timeline
Returns:
{Number} right

hideDOM()
Remove the items DOM from the current HTML container, but keep the DOM in memory

{Boolean} isVisible(start, end)
Check if the item is visible in the timeline, and not part of a cluster
Parameters:
{Date} start
{Date} end
Returns:
{Boolean} visible

{boolean} reflow()
Reflow the Item: retrieve its actual size from the DOM
Returns:
{boolean} resized returns true if the axis is resized

select()
Select the item

setPosition(left, right)
Reposition the item
Parameters:
{Number} left
{Number} right

showDOM(container)
Append the items DOM to the given HTML container. If items DOM does not yet exist, it will be created first.
Parameters:
{Element} container

unselect()
Unselect the item

updateDOM()
Update the DOM of the item. This will update the content and the classes of the item

updatePosition(timeline)
Reposition the item, recalculate its left, top, and width, using the current range of the timeline and the timeline options.
Parameters:
{links.Timeline} timeline

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Mar 04 2015 09:58:28 GMT+0100 (CET)