Class FacetedSearch

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

Deprecated

use FilteredSearch, a generalization of FacetedSearch

Hierarchy (view full)

FilteredSearch
- FacetedSearch

Constructors

constructor

new FacetedSearch(searchQuery, emptyParameterQuery?, modifiers?): FacetedSearch
Parameters
- searchQuery: Query<TupleTypes[]>
- OptionalemptyParameterQuery: Query<TupleTypes[]>
- Optionalmodifiers: Query<TupleTypes[]>[]
Returns FacetedSearch
Inherited from FilteredSearch.constructor
- Defined in FilteredSearch.ts:474

Properties

`Protected`_state

_state: FilteredSearchState

Accessors

`Protected`_filters

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

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:515

state

get state(): FilteredSearchState
Returns FilteredSearchState
Inherited from FilteredSearch.state
- Defined in FilteredSearch.ts:482

Methods

addFacet

addFacet(endpoint, type?, resetOnQueryChange?, filterEndpointPostfix?, filterEndpointParameterName?): void
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:486

addFilter

addFilter(obj): void
Parameters
- obj: Query<TupleTypes[]> | Filter
Returns void
Inherited from FilteredSearch.addFilter
- Defined in FilteredSearch.ts:511

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:507

addSimpleFilter

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

clearFacetSelection

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

clearFilterSelection

clearFilterSelection(endpoint?): void
Parameters
- Optionalendpoint: string
Returns void
Inherited from FilteredSearch.clearFilterSelection
- Defined in FilteredSearch.ts:551

clearParameters

clearParameters(): void
Returns void
Inherited from FilteredSearch.clearParameters
- Defined in FilteredSearch.ts:543

getBaseQuery

getBaseQuery(): Query<TupleTypes[]>
Returns Query<TupleTypes[]>
Inherited from FilteredSearch.getBaseQuery
- Defined in FilteredSearch.ts:527

getFacetQuery

getFacetQuery(facetEndpoint, excludeModifier?, includeSelf?): Query<TupleTypes[]>[]
Parameters
- facetEndpoint: string
- excludeModifier: boolean = false
- includeSelf: boolean = false
Returns Query<TupleTypes[]>[]
Inherited from FilteredSearch.getFacetQuery
- Defined in FilteredSearch.ts:535

getModifier

getModifier(): undefined | Query<TupleTypes[]>
Returns undefined | Query<TupleTypes[]>
Inherited from FilteredSearch.getModifier
- Defined in FilteredSearch.ts:523

getResultsQuery

getResultsQuery(excludeModifier?): Query<TupleTypes[]>[]
Parameters
- excludeModifier: boolean = false
Returns Query<TupleTypes[]>[]
Inherited from FilteredSearch.getResultsQuery
- Defined in FilteredSearch.ts:531

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
Parameters
- endpoint: string
- selection: FilterSelection
Returns void
Inherited from FilteredSearch.setFilterSelection
- Defined in FilteredSearch.ts:547

setModifier

setModifier(modifier): void
Parameters
- modifier: undefined | Query<TupleTypes[]>
Returns void
Inherited from FilteredSearch.setModifier
- Defined in FilteredSearch.ts:519

setParameter

setParameter(name, value): void
Parameters
- name: string
- value: string
Returns void
Inherited from FilteredSearch.setParameter
- Defined in FilteredSearch.ts:539

setSearchQuery

setSearchQuery(query): void
Parameters
- query: Query<TupleTypes[]>
Returns void
Inherited from FilteredSearch.setSearchQuery
- Defined in FilteredSearch.ts:555

setState

setState(results): void
Parameters
- results: Query<TupleTypes[]>[]
Returns void
Inherited from FilteredSearch.setState
- Defined in FilteredSearch.ts:559