Constructorsconstructor new Filtered Search ( searchQuery , emptyParameterQuery ? , modifiers ? ) : FilteredSearch Properties Accessors Methodsadd Facet add Facet ( endpoint , type ? , resetOnQueryChange ? , filterEndpointPostfix ? , filterEndpointParameterName ? ) : void Parameters endpoint : string type : FacetType = FacetType.single resetOnQueryChange : boolean = true filterEndpointPostfix : string = ':FILTER' filterEndpointParameterName : string = 'value' Returns void add Filter add Filter ( obj ) : void Returns void add Parameterized Filter add Parameterized Filter ( filterEndpoint , resetOnQueryChange ? , filterParameterName ? ) : void Parameters filterEndpoint : string resetOnQueryChange : boolean = true filterParameterName : string = 'value' Returns void add Simple Filter add Simple Filter ( filterEndpoint ) : void Returns void clear Filter Selection clear Filter Selection ( endpoint ? ) : void Returns void clear Parameters clear Parameters ( ) : void Returns void get Facet Query get Facet Query ( facetEndpoint , excludeModifier ? , includeSelf ? ) : Query < TupleTypes [] > [] Parameters facetEndpoint : string excludeModifier : boolean = false includeSelf : boolean = false get Results Query get Results Query ( excludeModifier ? ) : Query < TupleTypes [] > [] Parameters excludeModifier : boolean = false set Filter Selection set Filter Selection ( endpoint , selection ) : void Returns void set Modifier set Modifier ( modifier ) : void Returns void set Parameter set Parameter ( name , value ) : void Parameters name : string value : string Returns void set Search Query set Search Query ( query ) : void Returns void set State set State ( results ) : void Returns void
Associate Query objects with each other in a filtered search setup, using Filter definitions.
This class is a backwards-compatible wrapper around the plain state helpers. New framework-specific integrations should prefer storing FilteredSearchState directly and updating it with the
with*functions exported from this module.