SelectionObject

Overview

Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

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

Name	Description	Type
qTotal	Number of values in the field.	Integer
qIsNum	Optional parameter. This parameter is displayed if its value is true. Is set to true if the field is a numeric.	Boolean
qField	Name of the field that is selected.	String
qLocked	Optional parameter. This parameter is displayed if its value is true. Is set to true if the field is locked.	Boolean
qOneAndOnlyOne	Optional parameter. 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.	Boolean
qTextSearch	Optional parameter. Text that was used for the search. This parameter is filled when searching for a value and selecting it.	String
qSelectedCount	Number of values that are selected.	Integer
qSelected	Values that are selected.	String
qRangeInfo	Information about the range of selected values. Is empty if there is no range of selected values.	Array of RangeSelectInfo
qSortIndex	Sort index of the field. Indexing starts from 0.	Integer
qStateCounts	Number of values in a particular state.	NxStateCounts
qSelectedFieldSelectionInfo	Information about the fields that are selected.	Array of NxFieldSelectionInfo
qNotSelectedFieldSelectionInfo	Information about the fields that are not selected.	Array of NxFieldSelectionInfo
qSelectionThreshold	Maximum values to show in the current selections. The default value is 6.	Integer

Name	Description	Type
qRangeLo	Lowest value in the range.	Double
qRangeHi	Highest value in the range.	Double
qMeasure	Label of the measure.	String

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

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.

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 } ] }

Learn more

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