Skip to main content
Version: 2025.0

FilterGroup

A builder that can define a filter group.

Methods​

addFilterCondition​

addFilterCondition(pFilterCondition): FilterGroup

Adds a filter conditions.

Parameters​

pFilterCondition
FilterCondition

Returns​

FilterGroup

Example​

var filterConfig = neonFilter.createFilterGroup();
  filterGroupConfig.addFilterCondition(
  neonFilter.createFilterCondition()
  .field("FIELDNAME")
  .searchOperator(neonFilter.SEARCH_OPERATOR_EQUAL)
  .contentType(neonFilter.CONTENT_TYPE_TEXT)
  .value("VALUE")
  .key("KEY")
  );

addFilterGroup​

addFilterGroup(pFilterGroup): FilterGroup

Adds a filter group.

Parameters​

pFilterGroup
FilterGroup

Returns​

FilterGroup

Example​

var filterConfig = neonFilter.createFilterGroup();
  filterGroupConfig.addFilterGroup(
  neonFilter.createFilterGroup()
  .mergeOperator(neonFilter.MERGE_OPERATOR_AND)
  .addFilterCondition(
  neonFilter.createFilterCondition()
  .field("FIELDNAME")
  .searchOperator(neonFilter.SEARCH_OPERATOR_EQUAL)
  .contentType(neonFilter.CONTENT_TYPE_TEXT)
  .value("VALUE")
  .key("KEY")
  )
  );

getFilterConditions​

getFilterConditions(): FilterCondition[]

Returns the filter conditions as array.

Returns​

FilterCondition[]

the filter conditions

getFilterGroups​

getFilterGroups(): FilterGroup[]

Returns the filter groups as array.

Returns​

FilterGroup[]

the filter groups

getMergeOperator​

getMergeOperator(): string

Returns the merge operator which is used to combine the different filter conditions. Uses the constants that start with MERGE_OPERATOR_ of the package neonFilter.

Returns​

string

the merge operator

mergeOperator​

mergeOperator(pMergeOperator): FilterGroup

Sets a merge operator which is used to combine the different filter conditions. There is the possibility to merge the conditions with MERGE_OPERATOR_AND or MERGE_OPERATOR_OR. By default, the filter conditions are merged with MERGE_OPERATOR_AND.

Parameters​

pMergeOperator
string | number | boolean

Returns​

FilterGroup

Example​

var filterConfig = neonFilter.createFilterGroup();
  filterGroupConfig.mergeOperator(neonFilter.MERGE_OPERATOR_AND);

toJson​

toJson(): string

Converts the filter in a json format.

Returns​

string

the filter as json