API svyPopupFilter

Classes

AbstractPopupFilter

SvyCheckFilter ⇐ AbstractPopupFilter

SvyDateFilter ⇐ AbstractPopupFilter

SvyIntegerFilter ⇐ AbstractPopupFilter

SvyNumberFilter ⇐ AbstractPopupFilter

SvySelectFilter ⇐ AbstractPopupFilter

SvyTokenFilter ⇐ AbstractPopupFilter

Functions

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() ⇒ SvyCheckFilter

createDateFilter() ⇒ SvyDateFilter

createIntegerFilter() ⇒ SvyIntegerFilter

createNumberFilter() ⇒ SvyNumberFilter

createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilte

createTokenFilter() ⇒ SvyTokenFilter

getVersion() ⇒ String

Gets the version of this module

AbstractPopupFilter

• AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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

Extends: AbstractPopupFilter

• SvyCheckFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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> | 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

Extends: AbstractPopupFilter

• SvyDateFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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> | 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

Extends: AbstractPopupFilter

• SvyIntegerFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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> | 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

Extends: AbstractPopupFilter

• SvyNumberFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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> | 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

Extends: AbstractPopupFilter

• SvySelectFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getLookup() ⇒ scopes.svyLookup.Lookup
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • 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

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

Overrides: createWindow 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

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

Overrides: restoreState

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> | RuntimeForm.<AbstractLookup>

svySelectFilter.setText(text)

Sets the popupFilter text

Param	Type
text	String

svySelectFilter.setValues(values)

Overrides: setValues

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 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

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 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

Extends: AbstractPopupFilter

• SvyTokenFilter ⇐ AbstractPopupFilter

  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getText() ⇒ String
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setText(text)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ [ '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

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> | 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

createDateFilter() ⇒ SvyDateFilter

createIntegerFilter() ⇒ SvyIntegerFilter

createNumberFilter() ⇒ SvyNumberFilter

createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter

Param	Type
dataProvider	String
lookup	scopes.svyLookup.Lookup

createTokenFilter() ⇒ SvyTokenFilter

getVersion() ⇒ String

Gets the version of this module

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

---