Icon Filter

< appboard | 2.4 | builder

Many of AppBoard's Widgets incorporate the use of Icons, which can be selected and customized during Widget configuration that are used to represent data in the Widgets. In the configuration of these Widgets, the user selects a Default Icon from a variety of choices. Without any extra configuration, that Default Icon would be displayed for all records shown in the Widget.

In order to further customize the Widget and give more meaning to the Icons, AppBoard provides the option to add Icon Filters. These filters are sets of rules that use data attributes to determine the icon to represent each data record in the Widget. For instance, by adding an Icon Filter to a Topology Widget, you could show different icons for nodes within the topology based on their type or role. Icon Filters can be defined once and applied across multiple Widgets that use the same Data Collection, as long as those Widgets have the Icon Filter option available.


1. How To Create an Icon Filter

To add an Icon Filter click the Add button and a new window will appear where you can create the filter rules. To modify an existing Icon Filter, click the Edit button and perform the same steps to make any changes to the filter.


2. How To Configure an Icon Filter

Create a new filter, as described above, to open the Icon Filter Rules editor. Perform the following steps to configure Icon Filter Rules:

  1. Name: Provide a unique name for the set of rules so that it can be differentiated from other existing Icon Filter Rules. This is important since rule sets are saved and listed as Icon Filter options wherever the filters are applicable.
  2. Add: The Add button adds a new rule for the user to configure. Unless the Show Advanced Filter Options check box is selected, these rules will be configured in a Simple Property Comparison format.
  3. Remove Rule: In the far right side of the row of each rule is a red "X" button that can be used to remove a rule from the filter list.
  4. Icon Location: Toggle this switch to choose between using icons from the AppBoard library or icons derived from the data collection.
  5. Available Icons / URL Attribute: Click on this selector to choose an icon from the AppBoard library or from the data collection.
  6. Property: In the first pull-down of the comparison, select the field that will be the subject of this rule. Note that if the chosen field changes due to a change in the widget's Data Collection, Property will have to be set to the new field.
  7. Comparator: In the next pull-down, select an operator to define the comparison.
  8. Value: In the text box, enter in the value that the data will be filtered by.
  9. Show Advanced Filter Options: When the box is checked, the comparison pull-down selectors will be replaced by an Advanced button. Click the button to enter advanced configuration.
    • Note: Once Advanced filter rules have been created, they cannot be retained when unchecking the box to return to the basic mode. You will be prompted to delete any Advanced filter rules first before you can uncheck the box.

Note: Note that if an icon is specified that is unavailable, AppBoard will display the default icon instead.

3. Advanced Configuration of an Icon Filter

There are some key advantages that come with using the Advanced option. In addition to the Simple Property Comparison, the Advanced Filter provides to the user the Match Regular Expression comparison type. Advanced Filters also allow the user to add multiple comparisons to define one rule.

Once the Advanced box has been checked and the Advanced Filter button is clicked in the Icon Filter window, a new Filter Editor window will appear. Perform the following steps to configure an Advanced Filter in the Filter Editor:

  1. Add Rule: Choose either Simple Property Comparison (the basic comparison used in the previous window) or Match Regular Expression. A new row will appear with fields that match the selected comparison. See the linked pages for options specific to each comparison.
  2. Conjunction Type: Allows the user to restrict or expand the items that make it through the filter.
  3. Remove Rule: In the far right side of the row of each rule is a red "X" button that can be used to remove a rule from the filter list.
  4. Close: Once all comparisons have been added, click Finish to return to the Icon Filter page.