Class SpazTimelineNav

Defined in: spaztimelinenav.js.

Class Summary
Constructor Attributes Constructor Name and Description
 

Method Summary
Method Attributes Method Name and Description
 
enable(state)

 
init()

 
move(dir)

 
reveal(element)

if necessary, scrolls the container to reveal the passed element

 
select(element)

selects a given element by applying a class

 
setEntryClass(entry_class)

 
setSelectedClass(sel_class)

 

Class Detail

SpazTimelineNav(opts)

Parameters:
{Object} opts
options
{string} opts.timleine_id Optional
the id of the timeline we're navigating. Default is 'timeline'
{string} opts.selected_class Optional
the class of the currently selected entry. default is 'ui-selected'
{string} opts.entry_class Optional
the class of an entry in the timeline. default is 'entry'
{string} opts.keyup Optional
the shortcut code for the up navigation. default is 'up' (the up arrow)
{string} opts.keydown Optional
the shortcut code for the down navigation. default is 'down' (the down arrow)
Method Detail

enable(state)

Parameters:
state

init()

move(dir)

Parameters:
dir

reveal(element)

if necessary, scrolls the container to reveal the passed element

Parameters:
element

select(element)

selects a given element by applying a class

Parameters:
element

setEntryClass(entry_class)

Parameters:
entry_class

setSelectedClass(sel_class)

Parameters:
sel_class

setTimelineId(tlid)

Parameters:
tlid