Skip to main content Skip to complementary content

NxCurrentSelectionItem Class

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

Inheritance

  • System.Object
    • NxCurrentSelectionItem

Syntax

[ValueClass]
public class NxCurrentSelectionItem : INxCurrentSelectionItem

Constructors

Name Description
NxCurrentSelectionItem()

Properties

Name Description
Field

Name of the field that is selected.

JSON property name: qField

IsHidden

Optional parameter. Indicates if the selection is to be hidden in the Selections bar.

Is set to true if the current selection is hidden.

JSON property name: qIsHidden

IsNum

This parameter is displayed if its value is true.

Is set to true if the field is a numeric.

This parameter is optional.

JSON property name: qIsNum

Locked

This parameter is displayed if its value is true.

Is set to true if the field is locked.

This parameter is optional.

JSON property name: qLocked

NotSelectedFieldSelectionInfo

Information about the fields that are not selected.

JSON property name: qNotSelectedFieldSelectionInfo

OneAndOnlyOne

This parameter is displayed if its value is true.

Property that is set to a field. Is set to true if the field cannot be unselected.

This parameter is optional.

JSON property name: qOneAndOnlyOne

RangeInfo

Information about the range of selected values.

Is empty if there is no range of selected values.

JSON property name: qRangeInfo

ReadableName

Label that, if defined, is displayed in current selections instead of the actual expression.

JSON property name: qReadableName

Selected

Values that are selected.

JSON property name: qSelected

SelectedCount

Number of values that are selected.

JSON property name: qSelectedCount

SelectedFieldSelectionInfo

Information about the fields that are selected.

JSON property name: qSelectedFieldSelectionInfo

SelectionThreshold

Maximum values to show in the current selections.

The default value is 6.

JSON property name: qSelectionThreshold

SortIndex

Sort index of the field. Indexing starts from 0.

JSON property name: qSortIndex

StateCounts

Number of values in a particular state.

JSON property name: qStateCounts

TextSearch

Text that was used for the search. This parameter is filled when searching for a value and selecting it.

This parameter is optional.

JSON property name: qTextSearch

Total

Number of values in the field.

JSON property name: qTotal

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!