API svyToolbarFilter

Classes

ListComponentFilterRendererAbstractToolbarFilterUXNgGridListComponentFilterRendererListComponentFilterRenderer

Members

FILTER_TYPES

Functions

createFilterToolbar(listComponent, tableOrFoundSet)NgGridListComponentFilterRenderer

Creates a filter toolbar implementation using the custom list from the custom-rendered-components package.

This implementation expects an NG "Data Grid" table component and a "Custom List" component.

The filters offered from this implementation are generated from the table provided as follows:

  • any column with its filterType property set to TEXT will be offered as a token popup, allowing the user to enter any number of Strings to match

  • any column with its filterType property set to TEXT and the valuelist will be offered as a lookup where the user can search for and select any number of values

  • any column with its filterType property set to NUMBER will be offered as a number filter with a number of operators

  • any column with its filterType property set to DATE will be offered as a date filter with a number of operators

You should create a toolbar filter instance at the onLoad of your form and assign it to a form variable.

Make sure to re-direct the onClick event of the "List Component" to the toolbar.onClick(entry, index, dataTarget, event);

createSimpleFilterToolbar(listComponent, [foundsetToFilter])ListComponentFilterRenderer

Creates a filter toolbar implementation using the custom list from the custom-rendered-components package.

This implementation expects a "Custom List" component. An optional foundset to be filtered can be provided. If not given, the foundset of the form of the given list component is used.

Filters to be offered need to be added via the API method addFilter(titleText, dataProvider, filterType).

You should create a toolbar filter instance at the onLoad of your form and assign it to a form variable.

Make sure to re-direct the onClick event of the "List Component" to the toolbar.onClick(entry, index, dataTarget, event);

getConfigSortPickerAlphabetically()Boolean

Returns true if the filter picker is sorted alphabetically

setConfigDateDisplayFormat(displayFormat)

Sets global display date format to be used

setConfigSortPickerAlphabetically(sortAlphabetically)

Sort the the filter picker alphabetically. Default sort is based on column's position in grid.

setConfigUseNonVisibleColumns(useNonVisibleColumns)

Use only visible columns of the grid when set to false

setPopupDefaultOperator(formType, operator)

setPopupRendererForm(formType, form)

ListComponentFilterRenderer ⇐ AbstractToolbarFilterUX

Extends: AbstractToolbarFilterUX


listComponentFilterRenderer.addFilter(titleText, dataProvider, filterType) ⇒ Filter

ParamTypeDescription

titleText

String

dataProvider

String

filterType

String

any of the FILTER_TYPES enum values


listComponentFilterRenderer.applyFilters() ⇒ Boolean

Applies all filters

Returns: Boolean - true if records are loaded, false otherwise


listComponentFilterRenderer.clearFilterUI() ⇒ Boolean

Clears all filters from the UI and fires the onFilterRemovedEvent


listComponentFilterRenderer.executeSearch([searchText])

Executes the search

ParamTypeDescription

[searchText]

String

optional searchText to search for; if not provided here, call setSearchText() to set the search criteria before performing the search


listComponentFilterRenderer.getActiveFilters() ⇒ [ 'Array' ].<scopes.svyPopupFilter.AbstractPopupFilter>


listComponentFilterRenderer.getDataSource() ⇒ String

Returns the datasource to be filtered as the datasource of the form the filter UI Component is on

This method can be overwritten by subclasses to return for example the datasource of an NG Grid


listComponentFilterRenderer.getDefaultSearch() ⇒ scopes.svySearch.SimpleSearch


listComponentFilterRenderer.getElement() ⇒ RuntimeComponent

Returns the element used to display the filters

Overrides: getElement


listComponentFilterRenderer.getFilter(dataprovider) ⇒ Filter

Returns the Filter for the given dataprovider

ParamType

dataprovider

String


listComponentFilterRenderer.getFilters() ⇒ [ 'Array' ].<Filter>


listComponentFilterRenderer.getFoundSet() ⇒ JSFoundSet

Returns the foundset to be filtered as the foundset of the form the filter UI Component is on

This method can be overwritten by subclasses to return for example the foundset of an NG Grid


listComponentFilterRenderer.getQuery() ⇒ QBSelect

Applies all filters and returns the query for this toolbar


listComponentFilterRenderer.getSearchProvider(columnOrDataProvider) ⇒ scopes.svySearch.SearchProvider

Returns the SearchProvider for the given column or dataprovider

ParamType

columnOrDataProvider

CustomType.<aggrid-groupingtable.column> | String


listComponentFilterRenderer.getSearchText() ⇒ String

Returns the search text for the simple search


listComponentFilterRenderer.getSimpleSearch() ⇒ scopes.svySearch.SimpleSearch

Returns the SimpleSearch


listComponentFilterRenderer.getToolbarFiltersState() ⇒ [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>

Returns the filters' state of the toolbar

Returns: [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}> - jsonState


listComponentFilterRenderer.hasFilters() ⇒ Boolean

Returns true if the toolbar has any dataprovider it can filter on


listComponentFilterRenderer.onClick(entry, index, dataTarget, event)

Called when the mouse is clicked on a list entry.

ParamType

entry

object

index

Number

dataTarget

string

event

JSEvent


listComponentFilterRenderer.removeFilter(filter)

Removes the given filter

ParamType

filter


listComponentFilterRenderer.restoreToolbarFiltersState(jsonState)

Restores the filters' state

ParamType

jsonState

[ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>


listComponentFilterRenderer.search([searchText])

Applies all filters and executes the search

ParamTypeDescription

[searchText]

String

optional searchText to search for; if not provided here, call setSearchText() to set the search criteria before performing the search


listComponentFilterRenderer.setAutoApplyFilters(autoApply) ⇒ AbstractToolbarFilterUX

ParamType

autoApply

Boolean


listComponentFilterRenderer.setFilterValue(filter, values, operator)

Sets a filter value for the given filter

ParamType

filter

values

Array

operator

String


listComponentFilterRenderer.setOnFilterAddedCallback(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever a filter has been added

The callback method receives the Filter object of the filter added as argument

ParamType

callback

function


listComponentFilterRenderer.setOnFilterApplyCallback(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever the filter is applied The callback method receives an array of values, the operator and the filter as arguments

ParamType

callback

function


listComponentFilterRenderer.setOnFilterApplyQueryCondition(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever a query for a given filter is applied

This can be used to either modify the filter before the query is created or to enhance the provided QBSelect yourself

To prevent the filter from adding criteria to the query as it would normally do, the method being called can return false

The method called receives these parameters

  • @param {QBSelect} qbSelect the query to enhance @param {String} dataprovider the column/dataprovider of this filter @param {String} operator the operator used @param {Array} values the filter's values @param {scopes.svyPopupFilter.AbstractPopupFilter} filter the filter object

ParamType

callback

function


listComponentFilterRenderer.setOnFilterCreate(callback) ⇒ AbstractToolbarFilterUX

Allows to provide a method that will be called when the filter UI for a specific dataprovider is created That method then can create and return any filter that will then be used for this column

ParamTypeDescription

callback

function

function that receives the Filter object as argument and must return a scopes.svyPopupFilter.AbstractPopupFilter


listComponentFilterRenderer.setOnFilterRemovedCallback(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever a filter is removed

ParamType

callback

function


listComponentFilterRenderer.setOnSearchCommand(callback) ⇒ AbstractToolbarFilterUX

Set the onSearchCommand function to override the search behavior. You can add custom conditions to the filter query object;

ParamType

callback

function

Example

function onSearch(query, fs) {
  // add custom conditions to the query
  query.where.add(query.columns.orderdate.not.isNull);
  
  // apply the query to the foundset
  fs.loadRecords(query);
}

listComponentFilterRenderer.setSearchText() ⇒ AbstractToolbarFilterUX

Sets the search text for the simple search


listComponentFilterRenderer.showPopupFilterPicker(target)

Shows the filter picker popup

ParamType

target

RuntimeComponent


listComponentFilterRenderer.autoApply : Boolean


listComponentFilterRenderer.filters : [ 'Array' ].<Filter>


new ListComponentFilterRenderer(listComponent, [foundsetToFilter])

Filter Toolbar implementation using the custom list from the custom-rendered-components package. This implementation requires a "List Component" element and a foundset to filter. You should create a toolbar filter instance at the onLoad of your form and assign it to a form variable. Make sure to re-direct the onClick event of the "List Component" to the toolbar.onClick(entry, index, dataTarget, event);

ParamType

listComponent

RuntimeWebComponent.<customrenderedcomponents-customlist> | RuntimeWebComponent.<customrenderedcomponents-customlist_abs>

[foundsetToFilter]

JSFoundSet

Example

//keep track of toolbarFilter object in a form variable
var toolbarFilter;

//init the toolbarFilter at the onLoad.
function onLoad(event) {
 toolbarFilter = new scopes.svyToolbarFilter.ListComponentFilterRenderer(elements.filterToolbar, foundset)
}

//propagate the onClick event of the "List Component" to the toolbar filter.
function onClick(entry, index, dataTarget, event) {
 toolbarFilter.onClick(entry, index, dataTarget, event);
}

//optionally set a searchText for a cross-field search to further filter the result set
function search() {
 toolbarFilter.setSearchText(searchText);
 toolbarFilter.search();
}

NgGridListComponentFilterRenderer ⇐ ListComponentFilterRenderer

Extends: ListComponentFilterRenderer


ngGridListComponentFilterRenderer.addFilter(titleText, dataProvider, filterType) ⇒ Filter

ParamTypeDescription

titleText

String

dataProvider

String

filterType

String

any of the FILTER_TYPES enum values


ngGridListComponentFilterRenderer.applyFilters() ⇒ Boolean

Applies all filters

Returns: Boolean - true if records are loaded, false otherwise


ngGridListComponentFilterRenderer.clearFilterUI() ⇒ Boolean

Clears all filters from the UI and fires the onFilterRemovedEvent


ngGridListComponentFilterRenderer.executeSearch([searchText])

Executes the search

ParamTypeDescription

[searchText]

String

optional searchText to search for; if not provided here, call setSearchText() to set the search criteria before performing the search


ngGridListComponentFilterRenderer.getActiveFilters() ⇒ [ 'Array' ].<scopes.svyPopupFilter.AbstractPopupFilter>


ngGridListComponentFilterRenderer.getDataSource() ⇒ String

Returns the datasource to be filtered as the datasource of the NG Grid

Overrides: getDataSource


ngGridListComponentFilterRenderer.getDefaultSearch() ⇒ scopes.svySearch.SimpleSearch


ngGridListComponentFilterRenderer.getElement() ⇒ RuntimeComponent

Returns the element used to display the filters


ngGridListComponentFilterRenderer.getFilter(dataprovider) ⇒ Filter

Returns the Filter for the given dataprovider

ParamType

dataprovider

String


ngGridListComponentFilterRenderer.getFilters() ⇒ [ 'Array' ].<Filter>

Returns all filters of this ToolbarFilter

Overrides: getFilters


getFilters~filters

Array


ngGridListComponentFilterRenderer.getFoundSet() ⇒ JSFoundSet

Returns the foundset to be filtered as the foundset of the NG Grid

Overrides: getFoundSet


ngGridListComponentFilterRenderer.getQuery() ⇒ QBSelect

Applies all filters and returns the query for this toolbar


ngGridListComponentFilterRenderer.getSearchProvider(columnOrDataProvider) ⇒ scopes.svySearch.SearchProvider

Returns the SearchProvider for the given column or dataprovider

ParamType

columnOrDataProvider

CustomType.<aggrid-groupingtable.column> | String


ngGridListComponentFilterRenderer.getSearchText() ⇒ String

Returns the search text for the simple search


ngGridListComponentFilterRenderer.getSimpleSearch() ⇒ scopes.svySearch.SimpleSearch

Returns the SimpleSearch


ngGridListComponentFilterRenderer.getToolbarFiltersState() ⇒ [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>

Returns the filters' state of the toolbar

Returns: [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}> - jsonState


ngGridListComponentFilterRenderer.hasFilters() ⇒ Boolean

Returns true if the toolbar has any dataprovider it can filter on


ngGridListComponentFilterRenderer.onClick(entry, index, dataTarget, event)

Called when the mouse is clicked on a list entry.

ParamType

entry

object

index

Number

dataTarget

string

event

JSEvent


ngGridListComponentFilterRenderer.removeFilter(filter)

Removes the given filter

ParamType

filter


ngGridListComponentFilterRenderer.restoreToolbarFiltersState(jsonState)

Restores the filters' state

ParamType

jsonState

[ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>


ngGridListComponentFilterRenderer.search([searchText])

Applies all filters and executes the search

ParamTypeDescription

[searchText]

String

optional searchText to search for; if not provided here, call setSearchText() to set the search criteria before performing the search


ngGridListComponentFilterRenderer.setAutoApplyFilters(autoApply) ⇒ AbstractToolbarFilterUX

ParamType

autoApply

Boolean


ngGridListComponentFilterRenderer.setFilterValue(filter, values, operator)

Sets a filter value for the given filter

ParamType

filter

values

Array

operator

String


ngGridListComponentFilterRenderer.setOnFilterAddedCallback(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever a filter has been added

The callback method receives the Filter object of the filter added as argument

ParamType

callback

function


ngGridListComponentFilterRenderer.setOnFilterApplyCallback(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever the filter is applied The callback method receives an array of values, the operator and the filter as arguments

ParamType

callback

function


ngGridListComponentFilterRenderer.setOnFilterApplyQueryCondition(callback) ⇒ AbstractToolbarFilterUX

Sets a callback method that is fired whenever a query for a given filter is applied

This can be used to either modify the filter before the query is created or to enhance the provided QBSelect yourself

To prevent the filter from adding criteria to the query as it would normally do, the method being called can return false

The method called receives these parameters

  • @param {QBSelect} qbSelect the query to enhance @param {String} dataprovider the column/dataprovider of this filter @param {String} operator the operator used @param {Array} values the filter's values @param {scopes.svyPopupFilter.AbstractPopupFilter} filter the filter object