🍉 Meet Flexmonster Pivot Table & Charts 2.9.Check out all hot features!
Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. 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. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. 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
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      3. Flexmonster Admin Panel Guide
      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. Referencing 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
      7. The Data Server as a console application
        1. Installing the Data Server as a console application
        2. Configurations reference
        3. Data sources guide
        4. Security and authorization guide
      8. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
      4. Configuring the MongoDB Connector
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. 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. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. 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
    11. Connecting to other data sources
  5. Accessibility
    1. Accessibility overview
    2. Keyboard navigation
  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. Share the report
    11. Date and time formatting
    12. Configuring global options
    13. Export and print
    14. Calculated values
    15. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  9. 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
  10. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.8 to 2.9
    4. Migration guide from 2.7 to 2.8
    5. Migration guide from 2.6 to 2.7
    6. Migration guide from 2.5 to 2.6
    7. Migration guide from 2.4 to 2.5
    8. Migration guide from 2.3 to 2.4
    9. Migration guide from 2.2 to 2.3
  11. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  12. 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 choose which filters to enable in Flexmonster and support on the back end. 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 focuses on how to configure filters. Filters can be:

Available filter configurations

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

  • members (optional) – Boolean. Configures an include/exclude members filter. If true, the members filter is enabled in Flexmonster Pivot.
  • query (optional) – Boolean|Array of strings. Configures 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 this property is set to true, it 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. Configures 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 this property is set to true, it 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/or 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,

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

Configure filters for fields of a certain type

It is possible to specify the 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

Filters that are common for all the field types can be defined 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 these are the only conditions that are common for all the field types.

In the valueQuery property, you can specify which conditions are supported by the filter on values.

Filters for fields of a certain type

The string, number, and date properties allow you to configure 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 that are supported by the “string” field type.

In the valueQuery property, you can specify which conditions are supported by the filter on values.

Filters for the fields of the "number" and "date" types can be configured similarly. 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. This 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 which conditions are supported by 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. The supported conditions are the following: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".

For the members filter, the supported conditions depend on the field type. Have a look at 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, the handling of the query.filter part of the /select request should be implemented.

Note that 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 the "between" and "not_between" filters on the server.

What’s next?

You may be interested in the following articles: