Type Alias ListObjectDef

Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

type ListObjectDef = {
    qAutoSortByState?: NxAutoSortByStateDef;
    qDef?: NxInlineDimensionDef;
    qDirectQuerySimplifiedView?: boolean;
    qExpressions?: NxListObjectExpressionDef[];
    qFrequencyMode?: NxFrequencyMode;
    qInitialDataFetch?: NxPage[];
    qLibraryId?: string;
    qShowAlternatives?: boolean;
    qStateName?: string;
}
Index

Properties

qAutoSortByState? qDef? qDirectQuerySimplifiedView? qExpressions? qFrequencyMode? qInitialDataFetch? qLibraryId? qShowAlternatives? qStateName?

Properties

qAutoSortByState?: NxAutoSortByStateDef

Defines the sorting by state.

qDef?: NxInlineDimensionDef

Refers to a dimension stored in the list object.

qDirectQuerySimplifiedView?: boolean

If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.

Stability: experimental

qExpressions?: NxListObjectExpressionDef[]

Lists the expressions in the list object. This parameter is optional.

qFrequencyMode?: NxFrequencyMode

Defines the frequency mode. The frequency mode is used to calculate the frequency of a value in a list object. Default is NX_FREQUENCY_NONE . This parameter is optional.

One of:

  • N or NX_FREQUENCY_NONE
  • V or NX_FREQUENCY_VALUE
  • P or NX_FREQUENCY_PERCENT
  • R or NX_FREQUENCY_RELATIVE
qInitialDataFetch?: NxPage[]

Fetches an initial data set.

qLibraryId?: string

Refers to a dimension stored in the library.

qShowAlternatives?: boolean

If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

qStateName?: string

Name of the alternate state. Default is current selections $ .

Settings

Member Visibility

On This Page

Properties