Client Filters

Overview #

A client filter reduces the number of records displayed in a Visualization. It does not affect what gets returned from the server. To limit records returned from the server, administrators use variables inside of queries, which ultimately get displayed as Page Variables. Client filters are a separate concept, and act as a second layer of filtering. The two concepts are visually separated within the product as well. Server filters show up as Page Variables while client filters are displayed on the individual Visualizations they affect.

Client filters can be used in conjunction with server filters. The server filter is always applied first, limiting what is returned from the server. The client filter then runs against that result set, allowing it to be filtered again. It is important to keep this relationship in mind, because it can be easy for a server and client filter to fight with one another.

Currently, client filters only work with tabular datasets. Client filters will not show up as options for relational Visualizations like Topology and Flow Diagrams.

Create a Client Filter #

To create a client filter, perform the following steps:

  1. Log in to edgeSuite as an administrator.
  2. Open a Page in Edit Mode.
  3. Above the Visualization in which you want to add the client filter, click the gear button to show the options drop-down menu.
  4. Select “Edit Filters”.

Filter Types #

edgeSuite ships with several different types of client filters.

Filter
Description
Input
Client Pagination

Limits records by a configured number of rows, and allows an end user to “page” through the results.

Custom Expression Filter

Limits records by a custom expression which can compare values in multiple attributes.

Date Range Picker Limits records by a date range. This filter uses a calendar input, and lets the user select both a Start and End date.

Date Range Slider Limits records by a date range. This filter uses a slider input, and has an option to summarize the underlying data. The slider is placed on top of a spark line chart which can provide context for selection.

Realtime Date Filter Limits records by a date range. This filter binds End Date to the current date and time. It allows a user to select how far back in time to go using a set of durations.

Search Field Limits records by a supplied value. This filter allows a user to type characters into a text input, and then shows only those records which contain values that match.

String Constraint Filter Limits records by a supplied value. This filter can be bound to a set of constraints, which show unique values for a specified attribute.

Persistent Filters #

User-applied filters for a Visualization can be persisted during a session, across the user’s sessions on the same browser, or none at all. The behavior can be managed by setting the edge property key: client.filter.persistentStrategy to one of the following values:

value
Description
none

This was the behavior before version 3.8.4. Every visit to the same page starts with no filter setting set.

session

Filter setting for each Visualization is persisted during the duration of the user’s session. This is the default behavior.

user Filter setting for each Visualization is persisted across the user’s different sessions on the same browser. Multiple users can use the same browser without causing any issue.