1. Home
  2. Classes
  3. plugins.ChangeFilters

new ChangeFilters()

Description

Allows to change available filters after plugin initialization.

Details

plugins/change-filters/plugin.js, line 1

Methods

addFilter( newFilters [, position ] )

Description

Adds a new filter to the builder

Parameters
Name Type Attributes Default Description
newFilters QueryBuilder.Filter | Array.<Filter>
position int | string <optional>
 #end

index or '#start' or '#end'
Fires
Throws

ChangeFilterError

Details

plugins/change-filters/plugin.js, line 113

removeFilter( filterIds [, deleteOrphans ] )

Description

Removes a filter from the builder

Parameters
Name Type Attributes Default Description
filterIds string | Array.<string>
deleteOrphans boolean <optional>
 false

delete rules using old filters
Fires
Throws

ChangeFilterError

Details

plugins/change-filters/plugin.js, line 159

setFilters( [ deleteOrphans ], filters )

Description

Change the filters of the builder

Parameters
Name Type Attributes Default Description
deleteOrphans boolean <optional>
 false

delete rules using old filters
filters Array.<QueryBuilder>
Fires
Throws

ChangeFilterError

Details

plugins/change-filters/plugin.js, line 16

Events

changer:setFilters

Description

Modifies the filters before module:plugins.ChangeFilters.setFilters method

Parameters
Name Type Description
filters Array.<QueryBuilder.Filter>
Returns
Details

plugins/change-filters/plugin.js, line 26

afterSetFilters

Description

After module:plugins.ChangeFilters.setFilters method

Parameters
Name Type Description
filters Array.<QueryBuilder.Filter>
Details

plugins/change-filters/plugin.js, line 96