Skip to main content Skip to complementary content

ListObjectDef Class

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

Defines the properties of a list object.

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

Inheritance

Syntax

[ValueClass]
public class ListObjectDef : AbstractStructure, IDisposable, IListObjectDef, IAbstractStructure

Constructors

Name Description
ListObjectDef()

Creates an instance of the ListObjectDef class

Properties

Name Description
AutoSortByState

Defines the sorting by state.

JSON property name: qAutoSortByState

Def

Refers to a dimension stored in the list object.

JSON property name: qDef

DirectQuerySimplifiedView

If set to true, reduces the set of states returned.

Supported for Direct Query mode only.

Default is false.

JSON property name: qDirectQuerySimplifiedView

Expressions

Lists the expressions in the list object.

This parameter is optional.

JSON property name: qExpressions

FrequencyMode

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.

JSON property name: qFrequencyMode

InitialDataFetch

Fetches an initial data set.

JSON property name: qInitialDataFetch

LibraryId

Refers to a dimension stored in the library.

JSON property name: qLibraryId

ShowAlternatives

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.

JSON property name: qShowAlternatives

StateName

Name of the alternate state.

Default is current selections $ .

JSON property name: qStateName

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!