Tuesday, September 9, 2008

SIMILE Timeline

A co-worker sent me a link to the SIMILE Timeline. They now have a google project page, but I found that the documentation at their old site has proven to be quite helpful.

The overall concept is great: Display temporal information in a sliding window.

Unfortunately, their documentation has a lot to be desired. So, I have decided that I will start working on documenting their API (to get more familiar with it), and will hopefully become knowledgeable enough to extend it.

Here are some of the functions that I pulled out of their code. The goal is to expand this list, and enhance each of these items by providing the parameters, the return values, and a brief description.

For a given band:
(i.e. timeline = Timeline.create(blah blah);
timeline.getBand(0).


dispose
addOnScrollListener
removeOnScrollListener
setSyncWithBand
getLocale
getTimeZone
getLabeller
getIndex
getEther
getEtherPainer
getEventSource
getEventPainter
layout
paint
softLayout
softPaint
setBandShiftAndWidth
getViewWidth
setViewLength
getViewLength
getTotalViewLength
getViewOffset
getMinDate
getMaxDate
getMinVisibleDate
getMaxVisibleDate
getCenterVisibleDate
setMinVisibleDate
setMaxVisibleDate
setCenterVisibleDate
dateToPixelOffset
pixelOffsetToDate
createLayerDiv
removeLayerDiv
closeBubble
openBubbleForPoint
scrollToCenter
_onMouseDown
_onMouseMove
_onMouseUp
_onMouseOut
_onDblClick
_onKeyDown
_onKeyUp
_autoScroll
_moveEther
_onChanging
_fireOnScroll
_setSyncWithBandDate
_onHighlightBandScroll
_onAddMany
_onClear
_positionHighlight
_recenterDiv
_paintEvents
_softPaintEvents
_paintDecorators
_softPaintDecorators

Timeline.EventIndex
getUnit
removeAll
getCount
getIterator
getAllIterator
getEarliestDate
getLatestDate
_index

Feel free to provide your thoughts,
Chris