Class FacetedSearch

Associate Query objects with each other in a faceted search setup.

Deprecated

use FilteredSearch, a generalization of FacetedSearch

Hierarchy

FilteredSearch
- FacetedSearch

Index

Constructors

constructor

new FacetedSearch(searchQuery, emptyParameterQuery?, modifiers?): FacetedSearch
Parameters
- searchQuery: Query
- Optional emptyParameterQuery: Query
- Optional modifiers: Query[]
Returns FacetedSearch
Inherited from FilteredSearch.constructor
- Defined in FilteredSearch.ts:19

Properties

`Protected` _filters

_filters: Filter[] = []

Accessors

facets

get facets(): FacetFilter[]
Returns FacetFilter[]
- Defined in FacetedSearch.ts:20

filters

get filters(): Filter[]
Returns Filter[]
Inherited from FilteredSearch.filters
- Defined in FilteredSearch.ts:104

Methods

addFacet

addFacet(endpoint, type?, resetOnQueryChange?, filterEndpointPostfix?, filterEndpointParameterName?): void
Add a facet to the FilteredSearch object.
Parameters
- endpoint: string
- type: FacetType = FacetType.single
- resetOnQueryChange: boolean = true
- filterEndpointPostfix: string = ':FILTER'
- filterEndpointParameterName: string = 'value'
Returns void
Inherited from FilteredSearch.addFacet
- Defined in FilteredSearch.ts:42

addFilter

addFilter(obj): void
Add a filter to the FilteredSearch object.
Parameters
- obj: Query | Filter
  
  the Filter to be added or a Query object, from which a SimpleFilter or ParameterizedFilter will be deduced
Returns void
Inherited from FilteredSearch.addFilter
- Defined in FilteredSearch.ts:73

addParameterizedFilter

addParameterizedFilter(filterEndpoint, resetOnQueryChange?, filterParameterName?): void
Parameters
- filterEndpoint: string
- resetOnQueryChange: boolean = true
- filterParameterName: string = 'value'
Returns void
Inherited from FilteredSearch.addParameterizedFilter
- Defined in FilteredSearch.ts:63

addSimpleFilter

addSimpleFilter(filterEndpoint): void
Parameters
- filterEndpoint: string
Returns void
Inherited from FilteredSearch.addSimpleFilter
- Defined in FilteredSearch.ts:59

clearFacetSelection

clearFacetSelection(facetEndpoint?): void
Clear the selection for a given facet.
Parameters
- Optional facetEndpoint: string
Returns void
- Defined in FacetedSearch.ts:34

clearFilterSelection

clearFilterSelection(endpoint?): void
Clear the selection for all or a given filter.
Parameters
- Optional endpoint: string
Returns void
Inherited from FilteredSearch.clearFilterSelection
- Defined in FilteredSearch.ts:297

clearParameters

clearParameters(): void
Clear all searchQuery parameters

Returns void
Inherited from FilteredSearch.clearParameters
- Defined in FilteredSearch.ts:234

getBaseQuery

getBaseQuery(): Query
Get the Query to get the search results. Will return searchQuery as passed to the constructor unless a emptyParameterQuery was also passed and all parameters for searchQuery are empty.

Returns Query
Inherited from FilteredSearch.getBaseQuery
- Defined in FilteredSearch.ts:135

getFacetQuery

getFacetQuery(facetEndpoint, excludeModifier?, includeSelf?): Query[]
Get the Query objects to retrieve the facet options.
Parameters
- facetEndpoint: string
  
  name of the facet endpoint to fetch options for
- excludeModifier: boolean = false
  
  will skip applying the active modifier
- includeSelf: boolean = false
  
  keep the active facet filter for which options should be fetched in the query stack. Use when requesting RequestType.Options
Returns Query[]
Inherited from FilteredSearch.getFacetQuery
- Defined in FilteredSearch.ts:179

getModifier

getModifier(): undefined | Query
Get the currently active modifier query.

Returns undefined | Query
Inherited from FilteredSearch.getModifier
- Defined in FilteredSearch.ts:126

getResultsQuery

getResultsQuery(excludeModifier?): Query[]
Get the Query objects to retrieve search results. This includes the facet Query, if applicable.
Parameters
- excludeModifier: boolean = false
Returns Query[]
Inherited from FilteredSearch.getResultsQuery
- Defined in FilteredSearch.ts:151

setFacetSelection

setFacetSelection(facetEndpoint, selection): void
Set the selected options for a given facet.
Parameters
- facetEndpoint: string
- selection: string | string[]
Returns void
- Defined in FacetedSearch.ts:27

setFilterSelection

setFilterSelection(endpoint, selection): void
Set the selected options for a given filter or facet.
Parameters
- endpoint: string
- selection: undefined | null | string | number | (string | number)[] | (string | number)[][]
Returns void
Inherited from FilteredSearch.setFilterSelection
- Defined in FilteredSearch.ts:244

setModifier

setModifier(modifier): void
Set a query as modifier. Only modifiers in the list passed to constructor are allowed.
Parameters
- modifier: undefined | Query
Returns void
Inherited from FilteredSearch.setModifier
- Defined in FilteredSearch.ts:111

setParameter

setParameter(name, value): void
Set a parameter value for the searchQuery
Parameters
- name: string
- value: string
Returns void
Inherited from FilteredSearch.setParameter
- Defined in FilteredSearch.ts:216

setSearchQuery

setSearchQuery(query): void
Parameters
- query: Query
Returns void
Inherited from FilteredSearch.setSearchQuery
- Defined in FilteredSearch.ts:318

setState

setState(results): void
Overwrite the entire state with the values in the passed Query stack.
Parameters
- results: Query[]
  
  typically retrieved from a URL query parameter and then parsed with parseQueries
Returns void
Inherited from FilteredSearch.setState
- Defined in FilteredSearch.ts:327

Class FacetedSearch

Deprecated

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

searchQuery: Query

Optional emptyParameterQuery: Query

Optional modifiers: Query[]

Returns FacetedSearch

Properties

Protected _filters

Accessors

facets

Returns FacetFilter[]

filters

Returns Filter[]

Methods

addFacet

Parameters

endpoint: string

type: FacetType = FacetType.single

resetOnQueryChange: boolean = true

filterEndpointPostfix: string = ':FILTER'

filterEndpointParameterName: string = 'value'

Returns void

addFilter

Parameters

obj: Query | Filter

Returns void

addParameterizedFilter

Parameters

filterEndpoint: string

resetOnQueryChange: boolean = true

filterParameterName: string = 'value'

Returns void

addSimpleFilter

Parameters

filterEndpoint: string

Returns void

clearFacetSelection

Parameters

Optional facetEndpoint: string

Returns void

clearFilterSelection

Parameters

Optional endpoint: string

Returns void

clearParameters

Returns void

getBaseQuery

Returns Query

getFacetQuery

Parameters

facetEndpoint: string

excludeModifier: boolean = false

includeSelf: boolean = false

Returns Query[]

getModifier

Returns undefined | Query

getResultsQuery

Parameters

excludeModifier: boolean = false

Returns Query[]

setFacetSelection

Parameters

facetEndpoint: string

selection: string | string[]

Returns void

setFilterSelection

Parameters

endpoint: string

selection: undefined | null | string | number | (string | number)[] | (string | number)[][]

Returns void

setModifier

`Optional` emptyParameterQuery: Query

`Optional` modifiers: Query[]

`Protected` _filters

`Optional` facetEndpoint: string

`Optional` endpoint: string