This is an old revision of the document!


Filter

Protogrid has built-in filter mechanisms which are enabled by default for the most common use cases. For example if you have embedded a tableview on a proto for displaying next working steps the displayed entries are automatically filtered so only those next working steps are shown which are assigned to the current responsible (which is stored in a relation field on the same proto).

For every field type you can control specific behavioral aspects which are related to data filtering. For tableviews you can select from 4 types of filter fields to allow users dynamically limiting the data available.

Additionally to data filters Protogrid provides 2 data security features to restrict access to data: “Read Access Role Definition” and “Write Access Role Definition” fields (see protogrid/read_and_write_access_role_definition).

Filter Fields

A Filter field is basically a field for choosing a filter condition and limiting which Cards are shown in a Table View or Chart View.

Currently there exist 4 types of filter fields:

  • Relation Filter Field
  • Text Filter Field
  • Number Filter Field
  • Date Filter Field

Hint: if you want to combine multiple filter fields for tableview filtering the target fields must have activated the option “Enable Multi Column Indexing for this Field”:

Relation Filter

A relation filter field let's the user select from the available values in the target field and limits the embedded tableview based on the selection.

Text Filter

A text filter field let's the user enter any input.

Number Filter

A number filter field let's the user enter any input.

Date Filter

A date filter field provides a date picker to select a date. Filtering for time values is not supported.

Example: Creating a Relation Filter to filter a Table View

  1. Open the Proto on which the Table View, you want to filter, is defined
  2. Go to “Fields and Widgets” and then click on the “Create” button on the right
  3. Choose “Relation Filter Definition” to create a new “Relation Filter Definition” on the current Proto
  4. Assign a meaningful name for the new Relation Filter Field
  5. Define the “Related Proto” so that Cards based on this Proto will become filter choices
  6. Save & Close the “Relation Filter Definition”
  7. The new “Relation Filter Definition” now appears at the bottom of the “Fields and Widgets” list. You can drag & drop it to the desired position in this list
  8. Open the Table View you want to filter, and use the new “Relation Filter Field” to choose your filtering value

Example: Creating a Date Filter to filter a Chart View

  1. Open the Proto on which the Chart View, you want to filter, is defined
  2. Go to “Fields and Widgets” and then click on the “Create” button on the right
  3. Choose “Date Filter Definition” to create a new “Date Filter Definition” on the current Proto
  4. Assign a meaningful name for the new Date Filter Field
  5. Define the “Filter Target DateTime Field”, which is the field you want the data in the Chart View to filter for
  6. Save & Close the “Date Filter Definition”
  7. The new “Date Filter Definition” now appears at the bottom of the “Fields and Widgets” list. You can drag & drop it to the desired position in this list
  8. Open the Chart View, you want to filter, and use the new “Date Filter Field” to choose the data to filter for
Print/export