API svyNavigationHistory

Functions

back()scopes.svyNavigation.NavigationItem

Goes back one step in the navigation history from the current position

clearHistory()

Clears the history

getHistory()[ 'Array' ].<scopes.svyNavigation.NavigationItem>

Returns the history of navigation items

getHistoryIndex()Number

Returns the current index when navigating through the history or -1, when not navigating

getNavigationItemFromHistory(id)scopes.svyNavigation.NavigationItem

Returns the item with the given ID from the history stack when found and null otherwise

hasNext()Boolean

Returns true when a historyNext can be performed

hasPrevious()Boolean

Returns true when a historyBack can be performed

next()scopes.svyNavigation.NavigationItem

Goes forward one step in the navigation history from the current position

removeItemFromHistory(itemToRemove)

setMaxHistoryLength(historyLength)

Sets the maximum number of items held in the navigation history A maximum number of -1 means there is no limit to the number of items in the history

back() ⇒ scopes.svyNavigation.NavigationItem

Goes back one step in the navigation history from the current position


clearHistory()

Clears the history


getHistory() ⇒ [ 'Array' ].<scopes.svyNavigation.NavigationItem>

Returns the history of navigation items


getHistoryIndex() ⇒ Number

Returns the current index when navigating through the history or -1, when not navigating


getNavigationItemFromHistory(id) ⇒ scopes.svyNavigation.NavigationItem

Returns the item with the given ID from the history stack when found and null otherwise


hasNext() ⇒ Boolean

Returns true when a historyNext can be performed


hasPrevious() ⇒ Boolean

Returns true when a historyBack can be performed


next() ⇒ scopes.svyNavigation.NavigationItem

Goes forward one step in the navigation history from the current position


removeItemFromHistory(itemToRemove)


setMaxHistoryLength(historyLength)

Sets the maximum number of items held in the navigation history A maximum number of -1 means there is no limit to the number of items in the history


Last updated