Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Component overview
    2. Quick start
    3. System requirements
    4. Troubleshooting
    5. Managing license keys
    6. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Integration with Python
      1. Integration with Django
      2. Integration with Jupyter Notebook
    6. Integration with React Native
    7. Integration with AngularJS (v1.x)
    8. Integration with TypeScript
    9. Integration with R Shiny
    10. Integration with jQuery
    11. Integration with Ionic
    12. Integration with Electron.js
    13. Integration with Webpack
    14. Integration with RequireJS
  4. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    3. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
      6. Connecting to other databases
    4. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      3. Configurations reference
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referring the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
    5. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    6. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with the Accelerator
      3. Installing the Accelerator as a Windows service
      4. Referring the Accelerator as a DLL
      5. Configuring the authentication process
      6. Configuring a secure HTTPS connection
      7. Troubleshooting
    7. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implementing the custom data source API server
      5. Implementing filters
      6. Supporting more aggregation functions
      7. Returning data for the drill-through view
    8. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    9. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
  5. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with Google Charts
    5. Integration with FusionCharts
    6. Integration with any charting library
  8. Customizing
    1. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Customizing the pivot charts
    6. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
    9. Documentation for older versions
Table of contents

Implementing filters

The UI filters are disabled for the custom data source API connection in Flexmonster by default. You can decide which filters to enable in Flexmonster and support on the backend. This filter configuration can be done in the schema and the filtering itself should be implemented in the query.filter part of the /select request

The guide is focused on how to configure filters. The filters can be:

Available filter configurations

There are three properties in the /fields request through which the filters can be configured:

  • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled in Flexmonster Pivot.
  • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on members. This filter can be turned on either by setting the property to true or by specifying an array of supported conditions.
    If the property is set to true, this enables all the conditions that exist in Flexmonster Pivot for the members filter. See the list of supported conditions for “string”, “number”, and “date” field types.
  • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on either by setting the property to true or by specifying an array of supported conditions.
    If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter. See the list of supported conditions.

These configurations can be applied to all fields, to fields of a certain type, and to certain fields.

Turn on all filters at once

Turning on all filters at once is the simplest way to enable filtering. To enable all available filters, set the root filters property of the /fields request to true:

"filters": true,

Note that this approach requires implementing all the filters available in Flexmonster Pivot (see the list of supported filters).

Configure filters for fields of a certain type

There is an option to specify supported filtering conditions for fields of a certain type. This can be done in the root filters property of the /fields request.

Filters for any field type

Define the filters common for all the field types by specifying the filters.any property:

"filters": {
"any": {
"members": true,
"query": ["equal", "not_equal"],
"valueQuery": ["top","bottom"]
}
}

Here, the query property can contain only "equal", "not_equal", "between", and "not_between" conditions since only these conditions are common for all the field types.

In the valueQuery property, you can specify conditions supported for the filter on values.

Filters for fields of a certain type

string, number, and date properties allow configuring filters for fields of a corresponding type. Here is an example of filters configuration for the "string" field type:

"filters": {
"string": {
"members": true,
"query": ["equal", "not_equal"],
"valueQuery": ["top", "bottom"]
}
}

Here, the query property can contain conditions supported for the “string” field type.

In the valueQuery property, you can specify conditions supported for the filter on values.

In a similar way, filters for the fields of "number" and "date" types can be configured. See the list of supported conditions for “number” and “date” field types.

Define filters for individual fields

Filters can also be configured for individual fields. In can be done by specifying the fields.filters property:

"fields": [{
//other properties
"filters": {
"members": true,
"query": ["equal", "not_equal"],
"valueQuery": ["top", "bottom"]
}
}],

In the valueQuery property, you can specify conditions supported for the filter on values.

Conditions that can be defined in the query property depend on the field’s type. See the list of supported conditions for “string”, “number”, and “date” field types.

Supported filtering conditions

Conditions for the filter on values

Conditions for the filter on values are common for all field types. Supported conditions are the following: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".

For the members filter, supported conditions depend on the field type. Find the list of supported conditions for “string”, “number”, and “date” fields below.

Conditions for the “string” field type

The filter on members supports the following conditions for the "string" field type: "equal", "not_equal", "begin", "not_begin", "end", "not_end", "contain", "not_contain", "greater", "greater_equal", "less", "less_equal", "between", "not_between".

Conditions for the “number” field type

The filter on members supports the following conditions for the "number" field type:  "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".

Conditions for the “date” field type

The filter on members supports the following conditions for the "date" field type: "equal", "not_equal", "before", "before_equal", "after", "after_equal", "between", "not_between", "last", "current", "next".

After configuring the filters in the schema, handling of the query.filter part of the /select request should be implemented.

Note: the server always receives either "between" or "not_between" in the filtering request when Flexmonster Pivot uses the following date filters:

  • "equal"
  • "not_equal"
  • "last"
  • "current"
  • "next"

To use these date filters on the client, implement "between" and "not_between" filters on the server.

What’s next?

You may be interested in the following articles: