Script API Selection - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki

type

Description

The type of the filter, this can be static or dynamic. A static filter sets the values specified in the "values" option.

Required: Yes

Example

type: dynamic

objectType

Description

The type of the Qlik object. The objects "field" and "bookmark" are available. If you want to use dimensions, select the value "field".

Default: field

Example

objectType: bookmark

name

Description

The name of the field, dimension, or bookmark.

Required: Yes

Example

name: Fiscal Year

values

Description

The value of the Qlik object. This option is required if a static filter is used. This option is not required for dynamic filters. For a dynamic filter, you can specify restrictions on the field values to be looped.

Required: Yes (optional with type "dynamic")

Example

values: ["Africa”, "Europe”]

sorted

Description

Sorts the values to be looped in ascending (asc) or descending order (desc). Sorting can only be used with the option "type" being "dynamic".

Default: none

Example

sorted: desc