selectAssociations method

Note: 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

Introduced 1.1
Updated 2.0

Parameters

Name Type Description
qMatchIx Number

Optional.

Index to search result.

qTerms Array

Optional.

Values to select.

qOptions Object

Optional.

Parameter sent to the Qlik Associative Engine containing information about the search fields and the search context.

Parameters

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.

qSoftLock Object

Optional.

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

Returns

A promise of a Qlik Associative Engine reply.

Tip: For more information regarding a promise, see https://code.angularjs.org/1.5.8/docs/api/ng/service/$q#the-promise-api.

Example

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

Did this information help you?

Can you tell us why it did not help you and how we can improve it?