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;
}

Methods

clear exclude search select showMoreResults singleExclude singleSelect updateCaptions updateText

Methods

clear

  • clear(): void

    Resets the query and empties the values.

    Returns void

exclude

  • exclude(value: SpecificFacetSearchResult): void

    Excludes a facet search result.

    Parameters

    Returns void

search

  • search(): void

    Performs a facet search.

    Returns void

select

  • select(value: SpecificFacetSearchResult): void

    Selects a facet search result.

    Parameters

    Returns void

showMoreResults

  • showMoreResults(): void

    Shows more facet search results.

    Returns void

singleExclude

  • singleExclude(value: SpecificFacetSearchResult): void

    Excludes a search result while including facet values.

    Parameters

    Returns void

singleSelect

  • singleSelect(value: SpecificFacetSearchResult): void

    Selects a search result while deselecting facet values.

    Parameters

    Returns void

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

updateText

  • updateText(text: string): void

    Updates the facet search query.

    Parameters

    • text: string

      The query to search.

    Returns void

Settings

Member Visibility

On This Page

Methods