Class FacetedSearch

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

Hierarchy

FacetedSearch

Index

Constructors

Properties

_activeModifier? _facets _modifiers? emptyParameterQuery? modifiers? searchQuery

Accessors

Methods

addFacet clearFacetSelection clearParameters getBaseQuery getFacetQuery getModifier getResultsQuery setFacetSelection setModifier setParameter setSearchQuery

Constructors

constructor

new FacetedSearch(searchQuery, emptyParameterQuery?, modifiers?): FacetedSearch
Parameters
- searchQuery: Query
- Optional emptyParameterQuery: Query
- Optional modifiers: Query[]
Returns FacetedSearch
- Defined in FacetedSearch.ts:43

Properties

`Private` `Optional` _activeModifier

_activeModifier?: Query

`Private` _facets

_facets: Facet[] = []

`Private` `Optional` _modifiers

_modifiers?: Query[]

`Private` `Optional` emptyParameterQuery

emptyParameterQuery?: Query

`Private` `Optional` modifiers

modifiers?: Query[]

`Private` searchQuery

searchQuery: Query

Accessors

facets

get facets(): Facet[]
Returns Facet[]
- Defined in FacetedSearch.ts:83

Methods

addFacet

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

clearFacetSelection

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

clearParameters

clearParameters(): void
Clear all searchQuery parameters

Returns void
- Defined in FacetedSearch.ts:198

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
- Defined in FacetedSearch.ts:114

getFacetQuery

getFacetQuery(facetEndpoint, excludeModifier?): Query[]
Get the Query objects to retrieve the facet options. When using multiple facets, the facetEndpoint parameter is required.
Parameters
- facetEndpoint: string
- excludeModifier: boolean = false
Returns Query[]
- Defined in FacetedSearch.ts:150

getModifier

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

Returns undefined | Query
- Defined in FacetedSearch.ts:105

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[]
- Defined in FacetedSearch.ts:130

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

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
- Defined in FacetedSearch.ts:90

setParameter

setParameter(name, value): void
Set a parameter value for the searchQuery
Parameters
- name: string
- value: string
Returns void
- Defined in FacetedSearch.ts:180

setSearchQuery

setSearchQuery(query): void
Parameters
- query: Query
Returns void
- Defined in FacetedSearch.ts:247

Generated using TypeDoc