Filter

This is a Beta Release feature.  Configuration and functionality may be modified before formal release.

The Filter section can be added to provide a filter capability for the Gantt Chart sections. The fields included in the Filter section are configurable when the section is added to a template tab, dashboard, or presentation.

To include a Filter section in your solution:

  1. On a template tab, dashboard, or presentation, from Design mode, click Add Section.
  2. Select the Category of the Filter section (this is configurable but is typically: Visualizations).
  3. Click on the Filter option to add it to the layout.
  4. Click on the Settings gear in the top right corner of the section to open the Settings dialog.

5. Modify the settings to define the behavior of the Filter.

    • Title: A section title is optional. If there is no title, the Filter contents will fill the full section real estate. Toggle between a text value or an expression resulting in the title by clicking on the text/expression icon at the right of the field.
    • Filter ID: The ID to be referenced by the Gantt Chart sections to filter the Gantt content by the Filter section.

Filter Fields

      • Filter Name: Displayed as the field label for the filter field.
      • Filter Variable Name: When a Gantt Chart section is configured, a filtered value in the Gantt Chart section will map to the Filter section field by referencing the value in this setting.
      • Type = Text: Specifies that the Filter value will be text and results in a text field being displayed in the filter section.
      • Type = SingleSelect: Specifies that the Filter should display the defined options and allow for only one option to be selected.
        • Option Display: The label of the option displayed in the Filter section.
        • Option Value: The value that will be matched against the content being filtered.

        • Type = MultiSelect: Specifies that the Filter should display the defined options and allow for multiple options to be selected.
          • Option Display: The label of the option displayed in the Filter section.
          • Option Value: The value that will be matched against the content being filtered.

        • Type = Date
          • Start Range Date: Defines the starting point for the date range slider in the Filter section.
          • End Range Date: Defines the ending point for the date range slider in the Filter section.

      • Type (width): Determines how much of the width of the section this filter field should take. 12 represents the full width. With this selection you can define whether the filter fields are stacked vertically or spaced horizontally

6. Save the settings.

Note: There is no validation within the fields that accept expressions. If the expression is not entered correctly, the section will display an error on the instance, dashboard, or presentation.

If the section is being configured on a template, publish and create an instance to view the customized filter. If the section is configured on a dashboard or presentation, click Stop Editing to view the rendered section.

Prerequisite

The Filter section must be registered in the App.

 

Updated on April 18, 2023

Related Articles