Interface ISearchFilter

An interface that must be implemented by users of UISearch. It provides the basic functionality for filtering.

interface ISearchFilter {
    getFilterItemCount(): number;
    getFilterItemState(item: number): boolean;
    getItemFriendlyName(item: number): string;
    setFilterItemState(item: number, newValue: boolean): void;
}

Index

Methods

getFilterItemCount getFilterItemState getItemFriendlyName setFilterItemState

Methods

getFilterItemCount

getFilterItemCount(): number
Gets the number of filter items.

Returns number
The number of filter items.

getFilterItemState

getFilterItemState(item): boolean
Returns the current search filter state for the item.
Parameters
- item: number
  The index of the item to retrieve the state for.
Returns boolean
true if the item is on, false if off.

getItemFriendlyName

getItemFriendlyName(item): string
Returns the friendly name for the filter item.
Parameters
- item: number
  The index of the item to get a label for.
Returns string
A string that will be shown in the user interface.

setFilterItemState

setFilterItemState(item, newValue): void
Called whenever the use toggles a filter selection in the UI. Implementations should use this method to filter their search results.
Parameters
- item: number
  The index of the item that the user has toggled.
- newValue: boolean
  The new toggle value for the item.
Returns void