Type Alias NxCurrentSelectionItem

type NxCurrentSelectionItem = {
    qDimensionReferences?: DimensionReference[];
    qField?: string;
    qIsHidden?: boolean;
    qIsNum?: boolean;
    qLocked?: boolean;
    qNotSelectedFieldSelectionInfo?: NxFieldSelectionInfo[];
    qOneAndOnlyOne?: boolean;
    qRangeInfo?: RangeSelectInfo[];
    qReadableName?: string;
    qSelected?: string;
    qSelectedCount?: number;
    qSelectedFieldSelectionInfo?: NxFieldSelectionInfo[];
    qSelectionThreshold?: number;
    qSortIndex?: number;
    qStateCounts?: NxStateCounts;
    qTextSearch?: string;
    qTotal?: number;
}
Index

Properties

qDimensionReferences?: DimensionReference[]

List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

Stability: experimental

qField?: string

Name of the field that is selected.

qIsHidden?: boolean

Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

qIsNum?: boolean

This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

qLocked?: boolean

This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

qNotSelectedFieldSelectionInfo?: NxFieldSelectionInfo[]

Information about the fields that are not selected.

qOneAndOnlyOne?: boolean

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.

qRangeInfo?: RangeSelectInfo[]

Information about the range of selected values. Is empty if there is no range of selected values.

qReadableName?: string

Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

qSelected?: string

Values that are selected.

qSelectedCount?: number

Number of values that are selected.

qSelectedFieldSelectionInfo?: NxFieldSelectionInfo[]

Information about the fields that are selected.

qSelectionThreshold?: number

Maximum values to show in the current selections. The default value is 6.

qSortIndex?: number

Sort index of the field. Indexing starts from 0.

qStateCounts?: NxStateCounts

Number of values in a particular state.

qTextSearch?: string

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

qTotal?: number

Number of values in the field.