In Flexmonster, you can filter field members based on a certain condition. For example, you can create a filter to display dates of the previous quarter or countries that contain "Republic" in their name.
Visit our Examples page for live examples that demonstrate how to filter in Flexmonster.
The filter by condition exists for the following field types:
Each field type supports different filtering conditions. The filter’s availability for data sources also depends on the field type.
When a conditional filter is applied to a multilevel hierarchy, the filtering affects all hierarchy levels and behaves according to the logic described below.
If a parent hierarchy level matches the filter, Flexmonster displays:
If a parent hierarchy level does not match the filter, Flexmonster checks if any children match it. If so, the component shows:
If neither the parent nor any of its children match the filter, the entire hierarchy lever is hidden.
Go to the JSFiddle example to see how it works.
| Filter for number fields | Filter for string fields | Filter for date fields | Filter for time fields | |
|---|---|---|---|---|
| JSON | ||||
| CSV | ||||
| Flexmonster Data Server | ||||
| MongoDB | ||||
| Microsoft Analysis Services | ||||
| Custom data source API | * | * | * | |
| Elasticsearch |
* For the custom data source API, the filter by condition must be implemented on your server. For more details, refer to the Configuring filters guide.
The following filtering conditions are available for each data type:
Note Filter by condition works only for fields of the "date string" and "datetime" types. You can still apply selection and value filters to fields of other date types.
The filter by condition can be applied via UI, in the report, or using API:
Step 1. Open the filter view by clicking the field’s name or using the field’s context menu. You can resize the filter view using its window borders.
Step 2. Depending on the field’s type, select an option to filter by:
This will open a subview where you can specify the filter by condition.
Step 3. In the subview, choose a condition from the dropdown menu and enter a condition value in the input field.
The screenshot below shows an example of a filter configuration:
Step 4. Once the filter is configured, click the APPLY button to save your configuration.
If you want to preset a filter in your report, we recommend the following approach:
Your report will now contain the filter configuration. If needed, you can edit the filter configuration programmatically. To learn more, see the API reference:
To set or change the filter at runtime, use the setFilter() API call:
pivot.setFilter("Country", {
query: {
begin: "U",
},
});You can view the existing filter configuration using the getFilter() method.
Filter by condition can also be combined with the filter by selection. For more information, visit the Advanced tips guide.
Learn how to clear the filter by condition:
Right-click a cell with the field’s member to open the context menu. Then, select the Clear filter option.
Step 1. Open the filter view by clicking the field’s name or using the field’s context menu.
Step 2. Select the Clear filter option located in the lower-right corner of the subview:
Step 3. Click the APPLY button to save your changes.
You can clear all filters from a field using the clearFilter() API call. For example:
pivot.clearFilter("Country");