searchAssociations method

STABLE.

This API is reliable and breaking changes are unlikely.

qlik.app.searchAssociations(qTerms, qPage, qOptions, callback)

Searches for one or more terms in the values of a Qlik Sense app.

Version history

Version history
Version state	Details
Introduced	1.1
Deprecated	2.2 Use instead: searchResults method

Parameters

qTerms

Type: Array

Terms to search for.

qPage

Type: Object

Properties:

qPage object properties
Name	Type	Description
qOffset	Number	Position from the top, starting from 0.
qCount	Number	Number of search results to return.
qMaxNbrFieldMatches	Number	Maximum number of matching values to return per search result.

qOptions

Type: Object

Optional.

Search options.

Properties:

qOptions object properties
Name	Type	Description
qSearchFields	Array	List of search fields.
qContext	-	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.

callback

Type: Function

Optional.

Callback method. Registers a callback that is executed every time data is returned.

Returns

A promise of a Qlik associative engine reply.

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

Example

app.searchAssociations(["se"],
   {qOffset:0,qCount:15,qMaxNbrFieldMatches:5},
   {qContext: 'CurrentSelections'},
   function(reply){
	var str = "";
	reply.qResults.qFieldDictionaries.forEach(function(dic){
  	dic.qResult.forEach(function(result){
			str += result.qText;
		})
	});
	alert(str);
});

Did this page help you?

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!

Leave your feedback here