Class: FilterManager

@klevu/core / @klevu/core docid 7vdpes 8 0tv 43dya7ly / filtermanager filter manager is used to store and handle filters (facets) in the results easily it can be easily used with applyfilterwithfiltermanager() and listfilters() modifiers table of contents constructors class filtermanager docid\ ztqpueyzosyserbcqiw4h properties class filtermanager docid\ ztqpueyzosyserbcqiw4h accessors class filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4h methods class filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4hclass filtermanager docid\ ztqpueyzosyserbcqiw4h constructors constructor • new filtermanager ( initialvalues? ) manager can be initialized with existing options and sliders parameters name type description initialvalues? object initialize manager with values initialvalues filters? @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] given set of filters defined in store/filtermanager ts 52 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l52 properties filters • filters @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] = \[] defined in store/filtermanager ts 25 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l25 accessors options • get options () @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] use filters instead this doesn't take into account order of options and sliders returns @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] defined in store/filtermanager ts 30 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l30 sliders • get sliders () @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] use filters instead this doesn't take into account order of options and sliders returns @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] defined in store/filtermanager ts 40 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l40 methods clear ▸ clear () void clear current options and sliders returns void defined in store/filtermanager ts 82 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l82 clearoptionselections ▸ clearoptionselections ( key? ) void sets selected key of all options to false parameters name type description key? string optional key to lmit clearing to one option returns void defined in store/filtermanager ts 181 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l181 currentselection ▸ currentselection ( key ) undefined | string \[] get current selection by key parameters name type key string returns undefined | string \[] defined in store/filtermanager ts 298 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l298 deselectoption ▸ deselectoption ( key , value ) void deselect given option parameters name type description key string key of filter to deselect value string value of option to deselect returns void defined in store/filtermanager ts 158 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l158 getcurrentstate ▸ getcurrentstate () filtermanagerstate gets current state of filters returns filtermanagerstate current state defined in store/filtermanager ts 91 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l91 getoptionbykeycreateifnotexists ▸ private getoptionbykeycreateifnotexists ( key , value ) object get option by key and sub option name if doesn't exist, create it parameters name type key string value string returns object name type description count number name string name / label of filter selected boolean was this filter selected on the query value string value of filter that will be sent to backend defined in store/filtermanager ts 428 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l428 initfromlistfilters ▸ initfromlistfilters ( filters ) void parameters name type filters ( @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly )\[] returns void defined in store/filtermanager ts 59 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l59 readfromurlparams ▸ readfromurlparams ( params ) void set current selection of filters from a url param string parameters name type description params urlsearchparams urlsearchparams to read from returns void defined in store/filtermanager ts 358 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l358 selectoption ▸ selectoption ( key , value ) void select given option parameters name type description key string key of filter to select value string value of option to select returns void defined in store/filtermanager ts 134 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l134 selectedfilters ▸ selectedfilters () { key string ; label string ; type enumeration klevufiltertype docid\ ww8 ksa2 cuoaickix5tp ; value string }\[] quickly get all selected options and sliders returns { key string ; label string ; type enumeration klevufiltertype docid\ ww8 ksa2 cuoaickix5tp ; value string }\[] array of selected filters, with key, label, type and value defined in store/filtermanager ts 380 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l380 setstate ▸ setstate ( state ) void parameters name type state filtermanagerstate returns void defined in store/filtermanager ts 97 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l97 toapplyfilters ▸ toapplyfilters () @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] populate filter manager with filters from klevu api returns @klevu/core docid 7vdpes 8 0tv 43dya7ly \[] defined in store/filtermanager ts 255 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l255 tourlparams ▸ tourlparams () string changes current selection of filters to a url param string returns string string of url params defined in store/filtermanager ts 328 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l328 toggleoption ▸ toggleoption ( key , value ) void function to select filters in filter manager sends a dom event on change parameters name type description key string key of option value string value of option to toggle returns void defined in store/filtermanager ts 109 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l109 updateslide ▸ updateslide ( key , min , max ) void function to update slide in filter manager sends a dom event on change parameters name type description key string key of slide min number min value of slide max number max value of slide returns void defined in store/filtermanager ts 212 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l212 isklevufilterresultoptions ▸ static isklevufilterresultoptions ( filter ) filter is klevufilterresultoptions is given variable an option filter parameters name type filter @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly returns filter is klevufilterresultoptions defined in store/filtermanager ts 485 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l485 isklevufilterresultrating ▸ static isklevufilterresultrating ( filter ) filter is klevufilterresultrating is given variable an rating filter parameters name type filter @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly returns filter is klevufilterresultrating defined in store/filtermanager ts 499 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l499 isklevufilterresultslider ▸ static isklevufilterresultslider ( filter ) filter is klevufilterresultslider is given variable a slider filter parameters name type filter @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly | @klevu/core docid 7vdpes 8 0tv 43dya7ly returns filter is klevufilterresultslider defined in store/filtermanager ts 471 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/store/filtermanager ts#l471