Skip to main content Skip to complementary content

SearchGroupItemMatch Class

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

Inheritance

  • System.Object
    • SearchGroupItemMatch

Syntax

[ValueClass]
public class SearchGroupItemMatch : ISearchGroupItemMatch

Constructors

Name Description
SearchGroupItemMatch()

Properties

Name Description
Attributes

Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes

If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty.

For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains “qProperty”, "qMetaDef/title” if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” .

For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains "qNum", N where N is the numeric value of the element or NaN if the value is not numeric.

For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains "qElemNum", N where N is the value index of the element.

JSON property name: qAttributes

FieldSelectionMode

Selection mode of a field.

Suppressed by default. One and always one field value is selected when set to OneAndOnlyOne.

JSON property name: qFieldSelectionMode

Ranges

List of ranges.

For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.

JSON property name: qRanges

Text

Search match value.

Value of the search group item.

If the match is found in a field, it corresponds to the value of the field.

If the match is found in a generic object property, it corresponds to the property value.

JSON property name: qText

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!