Olympe SDK

Interface: Manager

olympe.dc.ranking. Manager

Ranking manager interface

Methods

activateDepth(depth)

Activate the ranking manager for the specified depth

Parameters:
Name Type Description
depth number
Throws:

If the manager has already been activated

Type
Error

<abstract> handleItem(added, tag, index [, value])

Handles an item (registers or unregisters it) that must be ranked.

This method returns a Deferred ranking object. This object will be passed to the following transformers like Related and Filter (but not Sort transformer), to handle the addition of new items (in case of relation) or removal of the item (in case of filtering)

Parameters:
Name Type Argument Description
added boolean

Whether the item is added or removed
tag string

Item's tag
index string

Item's index
value * <optional>

A value associated to the item, that can be used to sort it.
Returns:
Type
olympe.dc.ranking.Deferred

<abstract> isActivated()

Checks wether or not this manager has been activated

Returns:
Type
boolean

setRanksUpdateHandler(callback)

Sets a function called whenever ranks are updated. The callback gets the ordered array of children indexes as argument.

Parameters:
Name Type Description
callback olympe.dc.ranking.Manager.RanksUpdateCallback

updateActiveRanks()

Updates the ranks of all the items at the previously activated depth

Throws:

If the manager has not been activated yet

Type
Error

Type Definitions

RanksUpdateCallback(ranks)

Parameters:
Name Type Description
ranks Array.<string>