a!recordFilterList() Function

Function

a!recordFilterList( name, options, defaultOption, isVisible, allowMultipleSelections )

Creates a user filter category for the record list.

Parameters

Keyword Type Description

name

Text

The name of the user filter that displays to end users.

options

FacetOption Array

The options that users can select from for a given user filter.

defaultOption

Text

Determines which, if any, filter option is applied when a record list first loads.

isVisible

Boolean

Determines whether the filter is visible to the user at runtime. Default is true.

allowMultipleSelections

Boolean

Determines whether the filter allows the user to select multiple options or a single option. Default is true.

Returns

Facet

Usage considerations

This function creates a Facet type object, and is used within a Record Type Object

Options for the user filter are created with the a!recordFilterListOption() function. The most popular use of a!recordFilterList() is to generate filter options instead of manually writing them.

Since users can save filter values, try to use expressions that rarely change the options available. If users save an option that is not available the next time they load the record, a warning message will display and the user may need to update their saved filter.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
=a!recordFilterList(
  name: "Status",
  options: {
    a!recordFilterListOption(
      id: 1,
      name: "Active",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "active"
      )
    ),
    a!recordFilterListOption(
      id: 2,
      name: "Inactive",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "inactive"
      )
    )
  },
  defaultOption: "Active",
  isVisible: true,
  allowMultipleSelections: true
)

See Expression-Based User Filters for common uses.

Open in Github Built: Thu, Oct 14, 2021 (02:44:31 PM)

On This Page

FEEDBACK