SelectionObject
Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.
Properties
Selection object properties
| Name |
Description |
Type |
| BackCount |
Number of steps back. |
Integer |
| ForwardCount |
Number of steps forward. |
Integer |
| Selections |
Lists the fields that are selected. |
Array of NxCurrentSelectionItem
|
NxCurrentSelectionItem properties
| Name |
Description |
Type |
| qField |
Name of the field that is selected. |
String |
| qIsNum |
This parameter is displayed if its value is true.
Is set to true if the field is a numeric.
This parameter is optional.
|
Boolean |
| qLocked |
This parameter is displayed if its value is true.
Is set to true if the field is locked.
This parameter is optional.
|
Boolean |
| qNotSelectedFieldSelectionInfo |
Information about the fields that are not selected. |
Array of NxFieldSelectionInfo |
| qOneAndOnlyOne |
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.
|
Boolean |
| qRangeInfo |
Information about the range of selected values.
Is empty if there is no range of selected values.
|
Array of RangeSelectInfo |
| qReadableName |
Label that, if defined, is displayed in current selections instead of the actual expression.
|
String |
| qSelected |
Values that are selected. |
String |
| qSelectedCount |
Number of values that are selected. |
Integer |
| qSelectedFieldSelectionInfo |
Information about the fields that are selected. |
Array of NxFieldSelectionInfo |
| qSelectionThreshold |
Maximum values to show in the current selections.
The default value is 6.
|
Integer |
| qSortIndex |
Sort index of the field. Indexing starts from 0.
|
Integer |
| qStateCounts |
Number of values in a particular state. |
NxStateCounts
|
| qTextSearch |
Text that was used for the search. This parameter is filled when searching for a value and selecting it.
This parameter is optional.
|
String |
| qTotal |
Number of values in the field. |
Integer |
Range measures
| Name |
Description |
Type |
| qRangeLo |
Lowest value in the range. |
Double |
| qRangeHi |
Highest value in the range. |
Double |
| qMeasure |
Label of the measure. |
String |
NxStateCounts properties
| Name |
Description |
Type |
| qLocked |
Number of values in locked state. |
Integer |
| qSelected |
Number of values in selected state. |
Integer |
| qOption |
Number of values in optional state. |
Integer |
| qDeselected |
Number of values in deselected state. |
Integer |
| qAlternative |
Number of values in alternative state. |
Integer |
| qExcluded |
Number of values in excluded state. |
Integer |
| qSelectedExcluded |
Number of values in selected excluded state. |
Integer |
| qLockedExcluded |
Number of values in locked excluded state. |
Integer |
NxFieldSelectionInfo properties
| Name |
Description |
Type |
| qName |
Name of the field. |
String |
| qFieldSelectionMode |
Selection mode. |
One of:
- NORMAL for a selection in normal mode.
- AND for a selection in AND mode.
- NOT for a selection NOT in AND mode.
|
Example
"qSelectionObject": {
"qBackCount": 1,
"qForwardCount": 0,
"qSelections": [
{
"qTotal": 22,
"qField": "Country",
"qSelectedCount": 2,
"qSelected": "United States, Denmark",
"qRangeInfo": [],
"qSortIndex": 0
},
{
"qTotal": 6,
"qField": "Language",
"qSelectedCount": 1,
"qSelected": "English",
"qRangeInfo": [],
"qSortIndex": 1
},
{
"qTotal": 2,
"qField": "Temp",
"qSelectedCount": 1,
"qSelected": "Celsius",
"qRangeInfo": [],
"qSortIndex": 2
},
{
"qTotal": 2,
"qField": "Rainfall",
"qSelectedCount": 1,
"qSelected": "Inches",
"qRangeInfo": [],
"qSortIndex": 3
}
]
}
