For the complete documentation index, see llms.txt. This page is also available as Markdown.

API svyPopupFilter v1

Classes

AbstractPopupFilter

SvyDateFilterAbstractPopupFilter

SvyNumberFilterAbstractPopupFilter

SvySelectFilterAbstractPopupFilter

SvyTokenFilterAbstractPopupFilter

Functions

createDateFilter()SvyDateFilter

createNumberFilter()SvyNumberFilter

createSelectFilter(dataProvider, lookup)SvySelectFilter

createTokenFilter()SvyTokenFilter

AbstractPopupFilter


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


SvyDateFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

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


SvyNumberFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

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

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

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


OPERATOR

Properties

Name
Default

EQUALS

eq

GREATER_EQUAL

ge

GREATER_THEN

gt

SMALLER_EQUAL

le

SMALLER_THEN

lt

BETWEEN

BETWEEN

IS_IN

IN

createDateFilter() ⇒ SvyDateFilter

createNumberFilter() ⇒ SvyNumberFilter

createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter

Param
Type

dataProvider

String

lookup

scopes.svyLookup.Lookup

createTokenFilter() ⇒ SvyTokenFilter


Last updated

Was this helpful?