Class AjaxSolr.AbstractFacetWidget
Extends
AjaxSolr.AbstractWidget.
AbstractFacetWidget
Defined in: AbstractFacetWidget.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Baseclass for all facet widgets.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The field to facet on.
|
- Fields borrowed from class AjaxSolr.AbstractWidget:
- id, manager, target
| Method Attributes | Method Name and Description |
|---|---|
|
add(value)
Adds a filter query.
|
|
|
An abstract hook for child implementations.
|
|
|
changeSelection(Selection)
Helper for selection functions.
|
|
|
clear()
Removes all filter queries using the widget's facet field.
|
|
|
clickHandler(value)
|
|
|
fq(value, exclude)
|
|
|
isEmpty()
|
|
|
remove(value)
Removes a filter query.
|
|
|
unclickHandler(value)
|
- Methods borrowed from class AjaxSolr.AbstractWidget:
- afterRequest, beforeRequest, init
Field Detail
{String}
field
The field to facet on.
Method Detail
{Boolean}
add(value)
Adds a filter query.
- Parameters:
- value
- Returns:
- {Boolean} Whether a filter query was added.
afterChangeSelection()
An abstract hook for child implementations.
This method is executed after the filter queries change.
{Boolean}
changeSelection(Selection)
Helper for selection functions.
- Parameters:
- {Function} Selection
- function to call.
- Returns:
- {Boolean} Whether the selection changed.
{Boolean}
clear()
Removes all filter queries using the widget's facet field.
- Returns:
- {Boolean} Whether a filter query was removed.
{Function}
clickHandler(value)
- Parameters:
- {String} value
- The value.
- Returns:
- {Function} Sends a request to Solr if it successfully adds a filter query with the given value.
{String}
fq(value, exclude)
- Parameters:
- {String} value
- The facet value.
- {Boolean} exclude
- Whether to exclude this fq parameter value.
- Returns:
- {String} An fq parameter value.
{Boolean}
isEmpty()
- Returns:
- {Boolean} Whether any filter queries have been set using this widget's facet field.
{Boolean}
remove(value)
Removes a filter query.
- Parameters:
- value
- Returns:
- {Boolean} Whether a filter query was removed.
{Function}
unclickHandler(value)
- Parameters:
- {String} value
- The value.
- Returns:
- {Function} Sends a request to Solr if it successfully removes a filter query with the given value.