# API svyPopupFilter

### Classes

[AbstractPopupFilter](#abstractpopupfilter)

[SvyCheckFilter](#svycheckfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

[SvyDateFilter](#svydatefilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

[SvyIntegerFilter](#svyintegerfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

[SvyNumberFilter](#svynumberfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

[SvySelectFilter](#svyselectfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

[SvyTokenFilter](#svytokenfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

### Functions

[applyLocaleStrings(formName, formType)](#applylocalestrings-formname-formtype)

Applies the locale strings set on svyToolbarFilter.TOOLBAR\_LOCALE to the matching elements for the given form identifier which is one of TOOLBAR\_LOCALE's main properties

[createCheckFilter()](#createcheckfilter-svycheckfilter) ⇒ [`SvyCheckFilter`](#svycheckfilter-abstractpopupfilter)

[createDateFilter()](#createdatefilter-svydatefilter) ⇒ [`SvyDateFilter`](#svydatefilter-abstractpopupfilter)

[createIntegerFilter()](#createintegerfilter-svyintegerfilter) ⇒ [`SvyIntegerFilter`](#svyintegerfilter-abstractpopupfilter)

[createNumberFilter()](#createnumberfilter-svynumberfilter) ⇒ [`SvyNumberFilter`](#svynumberfilter-abstractpopupfilter)

[createSelectFilter(dataProvider, lookup)](#createselectfilter-dataprovider-lookup-svyselectfilter) ⇒ [`SvySelectFilte`](#svyselectfilter-abstractpopupfilter)

[createTokenFilter()](#createtokenfilter-svytokenfilter) ⇒ [`SvyTokenFilter`](#svytokenfilter-abstractpopupfilter)

[getVersion()](#getversion-string) ⇒ `String`

Gets the version of this module

### AbstractPopupFilter

* [AbstractPopupFilter](#abstractpopupfilter)
  * [.addParam(param)](#abstractpopupfilter.addparam-param)
  * [.clearParams()](#abstractpopupfilter.clearparams)
  * [.createPopUp(callback)](#abstractpopupfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#abstractpopupfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#abstractpopupfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#abstractpopupfilter.getid-string) ⇒ `String`
  * [.getOperator()](#abstractpopupfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#abstractpopupfilter.getparams-array) ⇒ `Array`
  * [.getState()](#abstractpopupfilter.getstate-object) ⇒ `Object`
  * [.getText()](#abstractpopupfilter.gettext-string) ⇒ `String`
  * [.getValues()](#abstractpopupfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#abstractpopupfilter.removeparam-index)
  * [.restoreState(jsonState)](#abstractpopupfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#abstractpopupfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#abstractpopupfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#abstractpopupfilter.setrendererform-popupfilterform)
  * [.setText(text)](#abstractpopupfilter.settext-text)
  * [.setValues(values)](#abstractpopupfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#abstractpopupfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#abstractpopupfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#abstractpopupfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### abstractPopupFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### abstractPopupFilter.clearParams()

Clear the params

#### abstractPopupFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### abstractPopupFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### abstractPopupFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### abstractPopupFilter.getID() ⇒ `String`

Gets the filter name

#### abstractPopupFilter.getOperator() ⇒ `String`

#### abstractPopupFilter.getParams() ⇒ `Array`

#### abstractPopupFilter.getState() ⇒ `Object`

#### abstractPopupFilter.getText() ⇒ `String`

Gets the popupFilter text

#### abstractPopupFilter.getValues() ⇒ `Array`

#### abstractPopupFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### abstractPopupFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### abstractPopupFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### abstractPopupFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### abstractPopupFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                   |
| --------------- | ---------------------------------------------------------------------- |
| popupFilterForm | [RuntimeForm.](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### abstractPopupFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### abstractPopupFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### abstractPopupFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### abstractPopupFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### abstractPopupFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

### SvyCheckFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvyCheckFilter](#svycheckfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svycheckfilter.addparam-param)
  * [.clearParams()](#svycheckfilter.clearparams)
  * [.createPopUp(callback)](#svycheckfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svycheckfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svycheckfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svycheckfilter.getid-string) ⇒ `String`
  * [.getOperator()](#svycheckfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svycheckfilter.getparams-array) ⇒ `Array`
  * [.getState()](#svycheckfilter.getstate-object) ⇒ `Object`
  * [.getText()](#svycheckfilter.gettext-string) ⇒ `String`
  * [.getValues()](#svycheckfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svycheckfilter.removeparam-index)
  * [.restoreState(jsonState)](#svycheckfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svycheckfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svycheckfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svycheckfilter.setrendererform-popupfilterform)
  * [.setText(text)](#svycheckfilter.settext-text)
  * [.setValues(values)](#svycheckfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svycheckfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or-ar) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svycheckfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svycheckfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### svyCheckFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svyCheckFilter.clearParams()

Clear the params

#### svyCheckFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### svyCheckFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svyCheckFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svyCheckFilter.getID() ⇒ `String`

Gets the filter name

#### svyCheckFilter.getOperator() ⇒ `String`

#### svyCheckFilter.getParams() ⇒ `Array`

#### svyCheckFilter.getState() ⇒ `Object`

#### svyCheckFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svyCheckFilter.getValues() ⇒ `Array`

#### svyCheckFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svyCheckFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svyCheckFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svyCheckFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svyCheckFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svyCheckFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svyCheckFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svyCheckFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyCheckFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyCheckFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

***

### SvyDateFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvyDateFilter](#svydatefilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svydatefilter.addparam-param)
  * [.clearParams()](#svydatefilter.clearparams)
  * [.createPopUp(callback)](#svydatefilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svydatefilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svydatefilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svydatefilter.getid-string) ⇒ `String`
  * [.getOperator()](#svydatefilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svydatefilter.getparams-array) ⇒ `Array`
  * [.getState()](#svydatefilter.getstate-object) ⇒ `Object`
  * [.getText()](#svydatefilter.gettext-string) ⇒ `String`
  * [.getValues()](#svydatefilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svydatefilter.removeparam-index)
  * [.restoreState(jsonState)](#svydatefilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svydatefilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svydatefilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svydatefilter.setrendererform-popupfilterform)
  * [.setText(text)](#svydatefilter.settext-text)
  * [.setValues(values)](#svydatefilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svydatefilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or-arr) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svydatefilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svydatefilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### svyDateFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svyDateFilter.clearParams()

Clear the params

#### svyDateFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### svyDateFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svyDateFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svyDateFilter.getID() ⇒ `String`

Gets the filter name

#### svyDateFilter.getOperator() ⇒ `String`

#### svyDateFilter.getParams() ⇒ `Array`

#### svyDateFilter.getState() ⇒ `Object`

#### svyDateFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svyDateFilter.getValues() ⇒ `Array`

#### svyDateFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svyDateFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svyDateFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svyDateFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svyDateFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svyDateFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svyDateFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svyDateFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyDateFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyDateFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

### SvyIntegerFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvyIntegerFilter](#svyintegerfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svyintegerfilter.addparam-param)
  * [.clearParams()](#svyintegerfilter.clearparams)
  * [.createPopUp(callback)](#svyintegerfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svyintegerfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svyintegerfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svyintegerfilter.getid-string) ⇒ `String`
  * [.getOperator()](#svyintegerfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svyintegerfilter.getparams-array) ⇒ `Array`
  * [.getState()](#svyintegerfilter.getstate-object) ⇒ `Object`
  * [.getText()](#svyintegerfilter.gettext-string) ⇒ `String`
  * [.getValues()](#svyintegerfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svyintegerfilter.removeparam-index)
  * [.restoreState(jsonState)](#svyintegerfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svyintegerfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svyintegerfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svyintegerfilter.setrendererform-popupfilterform)
  * [.setText(text)](#svyintegerfilter.settext-text)
  * [.setValues(values)](#svyintegerfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svyintegerfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svyintegerfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svyintegerfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### svyIntegerFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svyIntegerFilter.clearParams()

Clear the params

#### svyIntegerFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### svyIntegerFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svyIntegerFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svyIntegerFilter.getID() ⇒ `String`

Gets the filter name

#### svyIntegerFilter.getOperator() ⇒ `String`

#### svyIntegerFilter.getParams() ⇒ `Array`

#### svyIntegerFilter.getState() ⇒ `Object`

#### svyIntegerFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svyIntegerFilter.getValues() ⇒ `Array`

#### svyIntegerFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svyIntegerFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svyIntegerFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svyIntegerFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svyIntegerFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svyIntegerFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svyIntegerFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svyIntegerFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyIntegerFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyIntegerFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

### SvyNumberFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvyNumberFilter](#svynumberfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svynumberfilter.addparam-param)
  * [.clearParams()](#svynumberfilter.clearparams)
  * [.createPopUp(callback)](#svynumberfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svynumberfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svynumberfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svynumberfilter.getid-string) ⇒ `String`
  * [.getOperator()](#svynumberfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svynumberfilter.getparams-array) ⇒ `Array`
  * [.getState()](#svynumberfilter.getstate-object) ⇒ `Object`
  * [.getText()](#svynumberfilter.gettext-string) ⇒ `String`
  * [.getValues()](#svynumberfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svynumberfilter.removeparam-index)
  * [.restoreState(jsonState)](#svynumberfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svynumberfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svynumberfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svynumberfilter.setrendererform-popupfilterform)
  * [.setText(text)](#svynumberfilter.settext-text)
  * [.setValues(values)](#svynumberfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svynumberfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or-a) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svynumberfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svynumberfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### svyNumberFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svyNumberFilter.clearParams()

Clear the params

#### svyNumberFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### svyNumberFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svyNumberFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svyNumberFilter.getID() ⇒ `String`

Gets the filter name

#### svyNumberFilter.getOperator() ⇒ `String`

#### svyNumberFilter.getParams() ⇒ `Array`

#### svyNumberFilter.getState() ⇒ `Object`

#### svyNumberFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svyNumberFilter.getValues() ⇒ `Array`

#### svyNumberFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svyNumberFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svyNumberFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svyNumberFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svyNumberFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svyNumberFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svyNumberFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svyNumberFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyNumberFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyNumberFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

***

### SvySelectFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvySelectFilter](#svyselectfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svyselectfilter.addparam-param)
  * [.clearParams()](#svyselectfilter.clearparams)
  * [.createPopUp(callback)](#svyselectfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svyselectfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svyselectfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svyselectfilter.getid-string) ⇒ `String`
  * [.getLookup()](#svyselectfilter.getlookup-scopes.svylookup.lookup) ⇒ `scopes.svyLookup.Lookup`
  * [.getOperator()](#svyselectfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svyselectfilter.getparams-array) ⇒ `Array`
  * [.getState()](#svyselectfilter.getstate-object) ⇒ `Object`
  * [.getText()](#svyselectfilter.gettext-string) ⇒ `String`
  * [.getValues()](#svyselectfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svyselectfilter.removeparam-index)
  * [.restoreState(jsonState)](#svyselectfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svyselectfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svyselectfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svyselectfilter.setrendererform-popupfilterform)
  * [.setText(text)](#svyselectfilter.settext-text)
  * [.setValues(values)](#svyselectfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svyselectfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or-a) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svyselectfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svyselectfilter.showwindow-win-callback-array.less-than-jsrecord-greater-than-or-array.less-than-str) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [new SvySelectFilter(dataProvider, lookup)](#new-svyselectfilter-dataprovider-lookup)

#### svySelectFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svySelectFilter.clearParams()

Clear the params

#### svySelectFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

**Overrides**: [`createPopUp`](#abstractpopupfilter.createpopup-callback-plugins.window.formpopup)

#### svySelectFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Overrides**: [`createWindow`](#abstractpopupfilter.createwindow-x-y-width-height-jswindowtype-jswindow)\
**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svySelectFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svySelectFilter.getID() ⇒ `String`

Gets the filter name

#### svySelectFilter.getLookup() ⇒ `scopes.svyLookup.Lookup`

#### svySelectFilter.getOperator() ⇒ `String`

#### svySelectFilter.getParams() ⇒ `Array`

#### svySelectFilter.getState() ⇒ `Object`

**Overrides**: [`getState`](#abstractpopupfilter.getstate-object)

#### svySelectFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svySelectFilter.getValues() ⇒ `Array`

#### svySelectFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svySelectFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

**Overrides**: [`restoreState`](#abstractpopupfilter.restorestate-jsonstate-abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svySelectFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svySelectFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svySelectFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svySelectFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svySelectFilter.setValues(values)

**Overrides**: [`setValues`](#abstractpopupfilter.setvalues-values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svySelectFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Overrides**: [`showModalWindow`](#abstractpopupfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than)\
**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svySelectFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

**Overrides**: [`showPopUp`](#abstractpopupfilter.showpopup-callback-target-width-height)

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svySelectFilter.showWindow(win, \[callback]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a Window

**Overrides**: [`showWindow`](#abstractpopupfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than)\
**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                             |
| ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array\<String |

#### new SvySelectFilter(dataProvider, lookup)

| Param        | Type                      | Description                          |
| ------------ | ------------------------- | ------------------------------------ |
| dataProvider | `String`                  | will override the lookupDataProvider |
| lookup       | `scopes.svyLookup.Lookup` |                                      |

***

### SvyTokenFilter ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)

**Extends**: [`AbstractPopupFilter`](#abstractpopupfilter)

* [SvyTokenFilter](#svytokenfilter-abstractpopupfilter) ⇐ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.addParam(param)](#svytokenfilter.addparam-param)
  * [.clearParams()](#svytokenfilter.clearparams)
  * [.createPopUp(callback)](#svytokenfilter.createpopup-callback-plugins.window.formpopup) ⇒ `plugins.window.FormPopup`
  * [.createWindow(\[x\], \[y\], \[width\], \[height\], \[jsWindowType\])](#svytokenfilter.createwindow-x-y-width-height-jswindowtype-jswindow) ⇒ `JSWindow`
  * [.getDataProvider()](#svytokenfilter.getdataprovider-string) ⇒ `String`
  * [.getID()](#svytokenfilter.getid-string) ⇒ `String`
  * [.getOperator()](#svytokenfilter.getoperator-string) ⇒ `String`
  * [.getParams()](#svytokenfilter.getparams-array) ⇒ `Array`
  * [.getState()](#svytokenfilter.getstate-object) ⇒ `Object`
  * [.getText()](#svytokenfilter.gettext-string) ⇒ `String`
  * [.getValues()](#svytokenfilter.getvalues-array) ⇒ `Array`
  * [.removeParam(index)](#svytokenfilter.removeparam-index)
  * [.restoreState(jsonState)](#svytokenfilter.restorestate-jsonstate-abstractpopupfilter) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)
  * [.setDataProvider(dataProvider)](#svytokenfilter.setdataprovider-dataprovider)
  * [.setOperator(operator)](#svytokenfilter.setoperator-operator)
  * [.setRendererForm(popupFilterForm)](#svytokenfilter.setrendererform-popupfilterform)
  * [.setText(text)](#svytokenfilter.settext-text)
  * [.setValues(values)](#svytokenfilter.setvalues-values)
  * [.showModalWindow(\[callback\], \[x\], \[y\], \[width\], \[height\])](#svytokenfilter.showmodalwindow-callback-x-y-width-height-array.less-than-jsrecord-greater-than-or-ar) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`
  * [.showPopUp(callback, target, \[width\], \[height\])](#svytokenfilter.showpopup-callback-target-width-height)
  * [.showWindow(win, \[callback\])](#svytokenfilter.showwindow-win-callback-array-.less-than-string-or-date-or-number-greater-than) ⇒ `[ 'Array' ].<(String|Date|Number)>`

#### svyTokenFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

| Param | Type     |
| ----- | -------- |
| param | `Object` |

#### svyTokenFilter.clearParams()

Clear the params

#### svyTokenFilter.createPopUp(callback) ⇒ `plugins.window.FormPopup`

Creates and returns the popupFilter

| Param    | Type       | Description                                                                                                                             |
| -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

#### svyTokenFilter.createWindow(\[x], \[y], \[width], \[height], \[jsWindowType]) ⇒ `JSWindow`

**Returns**: `JSWindow` - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

| Param           | Type     | Description                                                                      |
| --------------- | -------- | -------------------------------------------------------------------------------- |
| \[x]            | `Number` |                                                                                  |
| \[y]            | `Number` |                                                                                  |
| \[width]        | `Number` | The width of the pop-up. Optional. Default is component width                    |
| \[height]       | `Number` | The height of the pop-up. Optional. Default is form height.                      |
| \[jsWindowType] | `Number` | Type of window; should be an option of JSWindow, Default JSWindow\.MODAL\_DIALOG |

#### svyTokenFilter.getDataProvider() ⇒ `String`

Gets the popupFilter dataprovider

#### svyTokenFilter.getID() ⇒ `String`

Gets the filter name

#### svyTokenFilter.getOperator() ⇒ `String`

#### svyTokenFilter.getParams() ⇒ `Array`

#### svyTokenFilter.getState() ⇒ `Object`

#### svyTokenFilter.getText() ⇒ `String`

Gets the popupFilter text

#### svyTokenFilter.getValues() ⇒ `Array`

#### svyTokenFilter.removeParam(index)

Removes a param at the specified index

| Param | Type     |
| ----- | -------- |
| index | `Number` |

#### svyTokenFilter.restoreState(jsonState) ⇒ [`AbstractPopupFilter`](#abstractpopupfilter)

| Param     | Type     |
| --------- | -------- |
| jsonState | `Object` |

#### svyTokenFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

| Param        | Type     |
| ------------ | -------- |
| dataProvider | `String` |

#### svyTokenFilter.setOperator(operator)

| Param    | Type     | Description                                 |
| -------- | -------- | ------------------------------------------- |
| operator | `String` | a value from scopes.svyPopupFilter.OPERATOR |

#### svyTokenFilter.setRendererForm(popupFilterForm)

| Param           | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| popupFilterForm | [`RuntimeForm.<AbstractPopupFilter>`](#abstractpopupfilter) \| `RuntimeForm.<AbstractLookup>` |

#### svyTokenFilter.setText(text)

Sets the popupFilter text

| Param | Type     |
| ----- | -------- |
| text  | `String` |

#### svyTokenFilter.setValues(values)

| Param  | Type    |
| ------ | ------- |
| values | `Array` |

#### svyTokenFilter.showModalWindow(\[callback], \[x], \[y], \[width], \[height]) ⇒ `Array.<JSRecord>` | `Array.<(String|Date|Number)>`

Shows the popupFilter in a modal Window

**Returns**: `Array.<JSRecord>` | `Array.<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| \[x]        | `Number`   |                                                                                                                                         |
| \[y]        | `Number`   |                                                                                                                                         |
| \[width]    | `Number`   | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height]   | `Number`   | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyTokenFilter.showPopUp(callback, target, \[width], \[height])

Shows the popupFilter

| Param     | Type               | Description                                                                                                                             |
| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| callback  | `function`         | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |
| target    | `RuntimeComponent` | The component to show relative to                                                                                                       |
| \[width]  | `Number`           | The width of the popupFilter. Optional. Default is same as target component                                                             |
| \[height] | `Number`           | The height of the popupFilter. Optional. Default is implementation-specifc.                                                             |

#### svyTokenFilter.showWindow(win, \[callback]) ⇒ `[ 'Array' ].<(String|Date|Number)>`

Shows the popupFilter in a Window

**Returns**: `[ 'Array' ].<(String|Date|Number)>` - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

| Param       | Type       | Description                                                                                                                             |
| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| win         | `JSWindow` | the JSWindow object to show                                                                                                             |
| \[callback] | `function` | The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array\<String |

### LOCALE

**Properties**

| Name                  | Default                                                                                                                                                                                                                                                           |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filterPopupMenu       | `{"addFilter":"Add filter"}`                                                                                                                                                                                                                                      |
| svyCheckPopupFilter   | `{"labelChecked":"Yes","labelUnchecked":"No"}`                                                                                                                                                                                                                    |
| svyDatePopupFilter    | `{"labelTitle":"Date","labelToday":"Today","labelTomorrow":"Tomorrow","labelThisWeek":"This week","labelNextWeek":"Next week","labelThisMonth":"This month","labelNextMonth":"Next month","labelThisYear":"This year","labelLastYear":"Last year","operator":""}` |
| svyTokenPopupFilter   | `{"searchbox":"","labelRemoveAll":"Remove all"}`                                                                                                                                                                                                                  |
| svySelectPopupFilter  | `{"searchText":"","labelSelectAll":"Select all","labelDeselectAll":"Deselect all"}`                                                                                                                                                                               |
| svyIntegerPopupFilter | `{"labelTitle":"Type filter value...","labelEqualTo":"Equal to","labelGreater":"Bigger than","labelSmaller":"Smaller than","labelBetween":"Between"}`                                                                                                             |
| svyNumberPopupFilter  | `{"labelTitle":"Type filter value...","labelEqualTo":"Equal to","labelGreater":"Bigger than","labelSmaller":"Smaller than","labelBetween":"Between"}`                                                                                                             |

### OPERATOR

**Properties**

| Name             | Default         | Description                                                   |
| ---------------- | --------------- | ------------------------------------------------------------- |
| IS\_NULL         | `isNull`        |                                                               |
| NOT\_NULL        | `!isNull`       |                                                               |
| EQUALS           | `eq`            |                                                               |
| EQUALS\_OR\_NULL | `^`             | eq                                                            |
| LIKE             | `like`          | All values starting with search input e.g. LIKE SEARCH\_WORD% |
| LIKE\_CONTAINS   | `like_contains` | All values containing search input e.g. LIKE %SEARCH\_WORD%   |
| GREATER\_EQUAL   | `ge`            |                                                               |
| GREATER\_THEN    | `gt`            |                                                               |
| SMALLER\_EQUAL   | `le`            |                                                               |
| SMALLER\_THEN    | `lt`            |                                                               |
| BETWEEN          | `BETWEEN`       |                                                               |
| IS\_IN           | `IN`            |                                                               |

### STYLING

**Properties**

| Name                               | Default               |
| ---------------------------------- | --------------------- |
| MUTLI\_SELECT\_ICON\_COLUMN\_WIDTH | `50`                  |
| MULTI\_SELECT\_SHOW\_TILE\_HEADERS | `true`                |
| CLOSE\_ICON                        | `fa fa-close`         |
| REMOVE\_ICON                       | `fa fa-trash`         |
| EXCLUDE\_ICON                      | `fas fa-minus-circle` |
| INCLUDE\_ICON                      | `fas fa-check-circle` |
| OPEN\_FILTER\_ICON                 | `fas fa-angle-down`   |
| REMOVE\_FILTER\_ICON               | `fas fa-times`        |

### applyLocaleStrings(formName, formType)

Applies the locale strings set on svyToolbarFilter.TOOLBAR\_LOCALE to the matching elements for the given form identifier which is one of TOOLBAR\_LOCALE's main properties

| Param    | Type     |
| -------- | -------- |
| formName | `String` |
| formType | `String` |

### createCheckFilter() ⇒ [`SvyCheckFilter`](#svycheckfilter-abstractpopupfilter)

### createDateFilter() ⇒ [`SvyDateFilter`](#svydatefilter-abstractpopupfilter)

### createIntegerFilter() ⇒ [`SvyIntegerFilter`](#svyintegerfilter-abstractpopupfilter)

### createNumberFilter() ⇒ [`SvyNumberFilter`](#svynumberfilter-abstractpopupfilter)

### createSelectFilter(dataProvider, lookup) ⇒ [`SvySelectFilter`](#svyselectfilter-abstractpopupfilter)

| Param        | Type                      |
| ------------ | ------------------------- |
| dataProvider | `String`                  |
| lookup       | `scopes.svyLookup.Lookup` |

### createTokenFilter() ⇒ [`SvyTokenFilter`](#svytokenfilter-abstractpopupfilter)

### getVersion() ⇒ `String`

Gets the version of this module

**Returns**: `String` - the version of the module using the format Major.Minor.Revision

***