Class Filter

Hierarchy

Filter

Index

Methods

Methods

Static filterStringTypes

filterStringTypes<T>(filterOptions: T[], codes?: string[]): T[]

- Defined in src/Filter/Filter.ts:81
Type parameters
- T: SearchFilterStringTypes
Parameters
- filterOptions: T[]
- Optional codes: string[]
Returns T[]

Static filterTargets

filterTargets(targets: TargetModel[], targetCodes: string[]): TargetModel[]

- Defined in src/Filter/Filter.ts:100
Filters targets with the given codes

Parameters
- targets: TargetModel[]
- targetCodes: string[]
Returns TargetModel[]

Static getClaimTargetCodes

getClaimTargetCodes(claims: ClaimModel[]): string[]

- Defined in src/Filter/Filter.ts:138
Returns the list of related target codes

Parameters
- claims: ClaimModel[]
Returns string[]

Static getCurrentClaimsFilter

getCurrentClaimsFilter(claims: ClaimModel[], filteredSubjects: SubjectModel[]): ClaimModel[] | undefined

- Defined in src/Filter/Filter.ts:150
Gets the list of current claims from dependent subjects

Parameters
- claims: ClaimModel[]
- filteredSubjects: SubjectModel[]
Returns ClaimModel[] | undefined

Static getCurrentInteractionTypes

getCurrentInteractionTypes(interactionTypes: InteractionTypeModel[], filteredSubjects: SubjectModel[]): InteractionTypeModel[] | undefined

- Defined in src/Filter/Filter.ts:169
Gets the list of current interaction types from dependent subjects

Parameters
- interactionTypes: InteractionTypeModel[]
- filteredSubjects: SubjectModel[]
Returns InteractionTypeModel[] | undefined

Static getCurrentTargets

getCurrentTargets(targets: TargetModel[], searchApiModel: SearchAPIParamsModel, filteredClaims: ClaimModel[]): TargetModel[] | undefined

- Defined in src/Filter/Filter.ts:192
Gets the list of current targets from dependent subjects and claims

Parameters
- targets: TargetModel[]
- searchApiModel: SearchAPIParamsModel
- filteredClaims: ClaimModel[]
Returns TargetModel[] | undefined

Static getSelectedCodes

getSelectedCodes(key: FilterType, filterModels: FilterCategoryModel[]): string[] | undefined

- Defined in src/Filter/Filter.ts:30
Returns a list of selected codes for the given FilterType and Categories

Parameters
- key: FilterType
- filterModels: FilterCategoryModel[]
Returns string[] | undefined

Static getSelectedGrade

getSelectedGrade(filterModels: FilterCategoryModel[]): GradeLevels | undefined

- Defined in src/Filter/Filter.ts:48
Reduces Filter Models for grade selections Exclusive OR to flip the bits for selected grades

Parameters
- filterModels: FilterCategoryModel[]
Returns GradeLevels | undefined

Static getSelectedTargets

getSelectedTargets(filterModels: FilterCategoryModel[]): string[] | undefined

- Defined in src/Filter/Filter.ts:71
Gets selected target hash values

Parameters
- filterModels: FilterCategoryModel[]
Returns string[] | undefined

Static getSubjectClaimCodes

getSubjectClaimCodes(subjects: SubjectModel[]): string[]

- Defined in src/Filter/Filter.ts:118
Returns the list of related claims

Parameters
- subjects: SubjectModel[]
Returns string[]

Static getSubjectInteractionTypes

getSubjectInteractionTypes(subjects: SubjectModel[]): string[]

- Defined in src/Filter/Filter.ts:128
Returns the list of related interaction types

Parameters
- subjects: SubjectModel[]
Returns string[]

Static getUpdatedSearchFilters

getUpdatedSearchFilters<T>(model: ItemsSearchModel, filters: T[], searchAPI: SearchAPIParamsModel): T[]

- Defined in src/Filter/Filter.ts:219
Returns Filter Categories with the updated dependent lists with selected values Dependent list Target, Claim, and Interaction Types

Type parameters
- T: FilterCategoryModel
Parameters
- model: ItemsSearchModel
- filters: T[]
- searchAPI: SearchAPIParamsModel
Returns T[]

Static hideFiltersBasedOnSearchParams

hideFiltersBasedOnSearchParams(filterList: FilterCategoryModel[], searchParams: SearchAPIParamsModel): FilterCategoryModel[]

- Defined in src/Filter/Filter.ts:317
Parameters
- filterList: FilterCategoryModel[]
- searchParams: SearchAPIParamsModel
Returns FilterCategoryModel[]

Static hideTargetOptions

hideTargetOptions<T>(filterCategories: T[], itemCards: ItemCardModel[]): T[]

- Defined in src/Filter/Filter.ts:337
Type parameters
- T: FilterCategoryModel
Parameters
- filterCategories: T[]
- itemCards: ItemCardModel[]
Returns T[]

Static updateSingleFilter

updateSingleFilter<T>(filter: T, basedOn: FilterCategoryModel): T

- Defined in src/Filter/Filter.ts:305
Updates the options in the filter based on the options in basedOn. This happens in place.

Type parameters
- T: FilterCategoryModel
Parameters
- filter: T
- basedOn: FilterCategoryModel
Returns T

Generated using TypeDoc