API svyToolbarFilter - Servoy/svyPopupFilter GitHub Wiki

ListComponentFilterRenderer ⇐ AbstractToolbarFilterUX

NgGridListComponentFilterRenderer ⇐ ListComponentFilterRenderer

FILTER_TYPES

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)

Extends: AbstractToolbarFilterUX

• ListComponentFilterRenderer ⇐ AbstractToolbarFilterUX
  • .addFilter(titleText, dataProvider, filterType) ⇒ Filter
  • .applyFilters() ⇒ Boolean
  • .clearFilterUI() ⇒ Boolean
  • .executeSearch([searchText])
  • .getActiveFilters() ⇒ [ 'Array' ].<scopes.svyPopupFilter.AbstractPopupFilter>
  • .getDataSource() ⇒ String
  • .getDefaultSearch() ⇒ scopes.svySearch.SimpleSearch
  • .getElement() ⇒ RuntimeComponent
  • .getFilter(dataprovider) ⇒ Filter
  • .getFilters() ⇒ [ 'Array' ].<Filter>
  • .getFoundSet() ⇒ JSFoundSet
  • .getQuery() ⇒ QBSelect
  • .getSearchProvider(columnOrDataProvider) ⇒ scopes.svySearch.SearchProvider
  • .getSearchText() ⇒ String
  • .getSimpleSearch() ⇒ scopes.svySearch.SimpleSearch
  • .getToolbarFiltersState() ⇒ [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>
  • .hasFilters() ⇒ Boolean
  • .onClick(entry, index, dataTarget, event)
  • .removeFilter(filter)
  • .restoreToolbarFiltersState(jsonState)
  • .search([searchText])
  • .setAutoApplyFilters(autoApply) ⇒ AbstractToolbarFilterUX
  • .setFilterValue(filter, values, operator)
  • .setOnFilterAddedCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterApplyCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterApplyQueryCondition(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterCreate(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterRemovedCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnSearchCommand(callback) ⇒ AbstractToolbarFilterUX
  • .setSearchText() ⇒ AbstractToolbarFilterUX
  • .showPopupFilterPicker(target)
  • .autoApply : Boolean
  • .filters : [ 'Array' ].<Filter>
  • new ListComponentFilterRenderer(listComponent, [foundsetToFilter])

Applies all filters

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

Clears all filters from the UI and fires the onFilterRemovedEvent

Executes the search

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

Returns the element used to display the filters

Overrides: getElement

Returns the Filter for the given dataprovider

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

Applies all filters and returns the query for this toolbar

Returns the SearchProvider for the given column or dataprovider

Returns the search text for the simple search

Returns the SimpleSearch

Returns the filters' state of the toolbar

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

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

Called when the mouse is clicked on a list entry.

Removes the given filter

Restores the filters' state

Applies all filters and executes the search

Sets a filter value for the given filter

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

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

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

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

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

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

Example

<pre>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);
}
</pre>

Sets the search text for the simple search

Shows the filter picker popup

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

Example

<pre>
//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();
}
</pre>

Extends: ListComponentFilterRenderer

• NgGridListComponentFilterRenderer ⇐ ListComponentFilterRenderer
  • .addFilter(titleText, dataProvider, filterType) ⇒ Filter
  • .applyFilters() ⇒ Boolean
  • .clearFilterUI() ⇒ Boolean
  • .executeSearch([searchText])
  • .getActiveFilters() ⇒ [ 'Array' ].<scopes.svyPopupFilter.AbstractPopupFilter>
  • .getDataSource() ⇒ String
  • .getDefaultSearch() ⇒ scopes.svySearch.SimpleSearch
  • .getElement() ⇒ RuntimeComponent
  • .getFilter(dataprovider) ⇒ Filter
  • .getFilters() ⇒ [ 'Array' ].<Filter>
    • ~filters
  • .getFoundSet() ⇒ JSFoundSet
  • .getQuery() ⇒ QBSelect
  • .getSearchProvider(columnOrDataProvider) ⇒ scopes.svySearch.SearchProvider
  • .getSearchText() ⇒ String
  • .getSimpleSearch() ⇒ scopes.svySearch.SimpleSearch
  • .getToolbarFiltersState() ⇒ [ 'Array' ].<{id: String, dataprovider: String, operator: String, params: Object, text: String, values: Array}>
  • .hasFilters() ⇒ Boolean
  • .onClick(entry, index, dataTarget, event)
  • .removeFilter(filter)
  • .restoreToolbarFiltersState(jsonState)
  • .search([searchText])
  • .setAutoApplyFilters(autoApply) ⇒ AbstractToolbarFilterUX
  • .setFilterValue(filter, values, operator)
  • .setOnFilterAddedCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterApplyCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterApplyQueryCondition(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterCreate(callback) ⇒ AbstractToolbarFilterUX
  • .setOnFilterRemovedCallback(callback) ⇒ AbstractToolbarFilterUX
  • .setOnSearchCommand(callback) ⇒ AbstractToolbarFilterUX
  • .setSearchText() ⇒ AbstractToolbarFilterUX
  • .showPopupFilterPicker(target)
  • .autoApply : Boolean
  • new NgGridListComponentFilterRenderer(listComponent, tableComponent)

Applies all filters

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

Clears all filters from the UI and fires the onFilterRemovedEvent

Executes the search

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

Overrides: getDataSource

Returns the element used to display the filters

Returns the Filter for the given dataprovider

Returns all filters of this ToolbarFilter

Overrides: getFilters

Array

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

Overrides: getFoundSet

Applies all filters and returns the query for this toolbar

Returns the SearchProvider for the given column or dataprovider

Returns the search text for the simple search

Returns the SimpleSearch

Returns the filters' state of the toolbar

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

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

Called when the mouse is clicked on a list entry.

Removes the given filter

Restores the filters' state

Applies all filters and executes the search

Sets a filter value for the given filter

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

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

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

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

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

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

Example

<pre>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);
}
</pre>

Sets the search text for the simple search

Shows the filter picker popup

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

Example

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

//init the toolbarFilter at the onLoad.
function onLoad(event) {
 toolbarFilter = scopes.svyToolbarFilter.createFilterToolbar(elements.filterToolbar, elements.table)
}

//propagate the onClick event of the "Custom 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.search(searchText);
}
</pre>

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

Example

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

//init the toolbarFilter at the onLoad.
function onLoad(event) {
 	toolbarFilter = scopes.svyToolbarFilter.createSimpleFilterToolbar(elements.filters);
 
 	var filter = toolbarFilter.addFilter('Customer', 'customerid', scopes.svyToolbarFilter.FILTER_TYPES.SELECT);
 	filter.setValueList('vlPopupCustomers');
 
		toolbarFilter.addFilter('City', 'shipcity', scopes.svyToolbarFilter.FILTER_TYPES.TOKEN);
}

//propagate the onClick event of the "Custom 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.search(searchText);
}
</pre>

Returns true if the filter picker is sorted alphabetically

Since: v1.3.0

Sets global display date format to be used

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

Since: v1.3.0

Use only visible columns of the grid when set to false

Since: v1.1.0

Since: v1.1.0

Example

<pre>
 // change default operator for TEXT token filters.
 scopes.svyToolbarFilter.setPopupDefaultOperator(scopes.svyToolbarFilter.FILTER_TYPES.TOKEN, scopes.svyPopupFilter.OPERATOR.LIKE);
</pre>

• FILTER_TYPES
  • .CHECK
  • .DATE
  • .INTEGER
  • .NUMBER
  • .SELECT
  • .TOKEN

Check filter

Date filter

INTEGER filter

Number filter

Select filter

Tokens filter