Interface FacetSearch

interface FacetSearch {
    clear(): void;
    exclude(value: SpecificFacetSearchResult): void;
    search(): void;
    select(value: SpecificFacetSearchResult): void;
    showMoreResults(): void;
    singleExclude(value: SpecificFacetSearchResult): void;
    singleSelect(value: SpecificFacetSearchResult): void;
    updateCaptions(captions: Record<string, string>): void;
    updateText(text: string): void;
}

Index

Methods

clear exclude search select showMoreResults singleExclude singleSelect updateCaptions updateText

Methods

clear

clear(): void
Resets the query and empties the values.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:206

exclude

exclude(value: SpecificFacetSearchResult): void
Excludes a facet search result.
Parameters
- value: SpecificFacetSearchResult
  The search result to exclude.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:190

search

search(): void
Performs a facet search.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:178

select

select(value: SpecificFacetSearchResult): void
Selects a facet search result.
Parameters
- value: SpecificFacetSearchResult
  The search result to select.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:184

showMoreResults

showMoreResults(): void
Shows more facet search results.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:174

singleExclude

singleExclude(value: SpecificFacetSearchResult): void
Excludes a search result while including facet values.
Parameters
- value: SpecificFacetSearchResult
  The search result to exclude.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:202

singleSelect

singleSelect(value: SpecificFacetSearchResult): void
Selects a search result while deselecting facet values.
Parameters
- value: SpecificFacetSearchResult
  The search result to select.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:196

updateCaptions

updateCaptions(captions: Record<string, string>): void
Updates the facet value captions.
Parameters
- captions: Record<string, string>
  A dictionary that maps index field values to facet value display names.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:211

updateText

updateText(text: string): void
Updates the facet search query.
Parameters
- text: string
  The query to search.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts:170