Exhibit » API » BrowseEngine class

Overview

This class implements a faceted browsing engine on top of the Exhibit database.

See Also: Collection

Constructors

new Exhibit.BrowseEngine(database, configuration)

Methods

dispose()

addListener(listener)

removeListener(listener)

getState()

setState(state)

setFacets(facetEntries)

facetEntries is an array of strings, each is an expression specifying how to retrieve the values of the corresponding facet. For example, facetEntries can be:

 [ ".age", ".gender", "!parentOf" ]

getFocus()

getCollectionCount()

getCurrentCollection()

getCollection(index)

getSlide(index)

getFacets()

getGroups(property, forward)

setRootCollection(itemSet)

setValueRestriction(property, forward, level, value, selected)

focus(index)

slide(propertyID, forward)

clearRestrictions()

applyRestrictions(restrictions)

clearFacetRestrictions(property, forward)

applyFacetRestrictions(property, forward, restrictions)

truncate(index)

group(property, forward, level, groupingProperty, groupingForward)

ungroup(property, forward, level)

Events

onChange()

onRootCollectionSet()

onRestrict()

onSlide()

onClearRestrictions()

onApplyRestrictions()

onClearFacetRestrictions()

onApplyFacetRestrictions()

onTruncate()

onGroup()

onUngroup()