Class ItemSearch

Hierarchy

ItemSearch

Index

Methods

Methods

Static filterItemCards

filterItemCards(itemCards: ItemCardModel[], filter: SearchAPIParamsModel): ItemCardModel[]

- Defined in src/ItemSearch/ItemSearch.ts:340
Parameters
- itemCards: ItemCardModel[]
- filter: SearchAPIParamsModel
Returns ItemCardModel[]

Static filterSearchToCategory

filterSearchToCategory(filter: SearchFilterModelTypes, searchApi?: SearchAPIParamsModel): FilterCategoryModel

- Defined in src/ItemSearch/ItemSearch.ts:327
Parameters
- filter: SearchFilterModelTypes
- Default value searchApi: SearchAPIParamsModel = {}
Returns FilterCategoryModel

Static filterToSearchApiModel

filterToSearchApiModel(filterModels: FilterCategoryModel[]): SearchAPIParamsModel

- Defined in src/ItemSearch/ItemSearch.ts:25
Parameters
- filterModels: FilterCategoryModel[]
Returns SearchAPIParamsModel

Static getFilterOptionModel

getFilterOptionModel(filter: SearchFilterModelTypes, searchApi?: SearchAPIParamsModel): FilterOptionModel[]

- Defined in src/ItemSearch/ItemSearch.ts:244
Parameters
- filter: SearchFilterModelTypes
- Default value searchApi: SearchAPIParamsModel = {}
Returns FilterOptionModel[]

Static getFlagCodes

getFlagCodes(searchFlag?: undefined | true | false): string[]

- Defined in src/ItemSearch/ItemSearch.ts:318
Parameters
- Optional searchFlag: undefined | true | false
Returns string[]

Static getTechnologyTypeCodes

getTechnologyTypeCodes(search: SearchAPIParamsModel): string[]

- Defined in src/ItemSearch/ItemSearch.ts:306
Parameters
- search: SearchAPIParamsModel
Returns string[]

Static searchOptionFilterString

searchOptionFilterString(options: SearchFilterStringTypes[], filterType: FilterType, selectedCodes?: string[]): FilterOptionModel[]

- Defined in src/ItemSearch/ItemSearch.ts:179
Parameters
- options: SearchFilterStringTypes[]
- filterType: FilterType
- Optional selectedCodes: string[]
Returns FilterOptionModel[]

Static searchOptionToFilterClaim

searchOptionToFilterClaim(options: ClaimModel[], filterType: FilterType, selectedCodes?: string[]): FilterOptionModel[]

- Defined in src/ItemSearch/ItemSearch.ts:229
Parameters
- options: ClaimModel[]
- filterType: FilterType
- Optional selectedCodes: string[]
Returns FilterOptionModel[]

Static searchOptionToFilterGrade

searchOptionToFilterGrade(options: GradeLevels[], filterType: FilterType, selectedCode?: GradeLevels): FilterOptionModel[]

- Defined in src/ItemSearch/ItemSearch.ts:194
Parameters
- options: GradeLevels[]
- filterType: FilterType
- Optional selectedCode: GradeLevels
Returns FilterOptionModel[]

Static searchOptionToFilterTarget

searchOptionToFilterTarget(options: TargetModel[], filterType: FilterType, selectedCodes?: string[]): FilterOptionModel[]

- Defined in src/ItemSearch/ItemSearch.ts:214
Parameters
- options: TargetModel[]
- filterType: FilterType
- Optional selectedCodes: string[]
Returns FilterOptionModel[]

Static updateDependentSearchParams

updateDependentSearchParams(searchParams: SearchAPIParamsModel, model: ItemsSearchModel): SearchAPIParamsModel

- Defined in src/ItemSearch/ItemSearch.ts:141
Takes a SearchAPIParamsModel and modifies it in place, removing the dependent params whose parents are no longer visible to the user.

Parameters
- searchParams: SearchAPIParamsModel
- model: ItemsSearchModel
Returns SearchAPIParamsModel

Static updateSearchApiModel

updateSearchApiModel(category: FilterCategoryModel, currentModel: SearchAPIParamsModel): SearchAPIParamsModel

- Defined in src/ItemSearch/ItemSearch.ts:78
Takes a SearchAPIParamsModel and the filter category that has been updated, and updates the search params model accordingly, returning a copy of it with the updated param added/removed.

Parameters
- category: FilterCategoryModel
- currentModel: SearchAPIParamsModel
Returns SearchAPIParamsModel

Generated using TypeDoc