selectAssociations method

STABLE.

This API is reliable and breaking changes are unlikely.

qlik.app.selectAssociations(qMatchIx, qTerms, qOptions)

Makes a selection based on searchResults method results.

Version history

Version history
Version state	Details
Introduced	1.1
Updated	2.0

Type: Number

Optional.

Index to search result.

Type: Array

Optional.

Values to select.

Type: Object

Optional.

Parameter sent to the Qlik associative engine containing information about the search fields and the search context.

Parameters

qOptions object properties
Name	Type	Description
qSearchFields	Array or String	List of the search fields. If empty, the search is performed in all fields of the app.
qContext	String	Search context. Can be one of: Cleared: In this mode, the first step is to clear any current selections in the app. The second step is to search for one or more terms in the values of the app. LockedFieldsOnly: In this mode, the search applies only to the values associated with the selections made in locked fields, ignoring selections in any unlocked field. If no locked fields, the behavior is identical to the Cleared context. You cannot make any new selections in a locked field. You can get search hits for the associated values of a locked field but you cannot get the search hits for the non associative values. CurrentSelections: In this mode, the current selections are kept (if any). Search for one or more terms in the values of the app. New selections are made on top of the current selections. If no selections were made before the search, this mode is identical to the Cleared context. Default value is LockedFieldsOnly.

Type: Object

Optional.

This parameter was deprecated in version 2.0 and is ignored in later versions. Use the qOtions.qContext parameter instead.

A promise of a Qlik associative engine reply.

For more information regarding a promise, see The Promise API.

app.selectAssociations( 0, ["May","Mar"] );

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!