ListObjectDef

Overview

Defines the properties of a list object.

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

Properties

Name	Description	Type
qStateName	Name of the alternate state. Default is current selections $.	String
qLibraryId	Refers to a dimension stored in the library.	String
qDef	Refers to a dimension stored in the list object.	Null or NxInlineDimensionDef
qAutoSortByState	Defines the sorting by state.	Null or NxAutoSortByStateDef
qFrequencyMode	Defines the frequency mode. The frequency mode is used to calculate the frequency of a value in a list object. This parameter is optional. Default is NX_FREQUENCY_NONE.	One of: • NX_FREQUENCY_NONE • NX_FREQUENCY_VALUE • NX_FREQUENCY_PERCENT. The percentage is between 0 and 100. • NX_FREQUENCY_RELATIVE. Same as percent except that the relative value is between 0 and 1.
qShowAlternatives	If set to true, alternative values are allowed in qData. This parameter is optional. The default value is true. If set to false, no alternative values are displayed in qData. Values are excluded instead. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values.	Boolean
qInitialDataFetch	Fetches an initial data set.	Array of NxPage
qExpressions	Lists the expressions in the list object. This parameter is optional.	Array of NxListObjectExpressionDef

Either qDef or qLibraryId should be set, but not both. If both parameters are set the engine uses qDef definition.

If the dimension is set in the object itself and not in the library, this dimension cannot be shared with other objects.

A dimension that is set in the library can be used by many objects.

Name	Description	Type
qGrouping	Used to define a cyclic group or drill-down group. This parameter is optional. Default value is no grouping.	One of: N for no grouping H for drill-down C for cyclic
qFieldDefs	Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.	Array of String
qFieldLabels	Array of field labels. This parameter is optional.	Array of String
qSortCriterias	Defines the sorting criteria in the field. This parameter is optional. Default is to sort by alphabetical order, ascending.	Array of SortCriteria
qNumberPresentations	Defines the format of the value. This parameter is optional.	Array of FieldAttributes
qReverseSort	If set to true, it inverts the sort criteria in the field.	Boolean
qActiveField	Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions (qGrouping is C).	Integer

Name	Description	Type
qType	Type of the field. Default is U.	One of: • U for UNKNOWN type. • A for ASCII; Numeric fields values contain only standard ASCII characters. • I for INTEGER; Numeric fields values are shown as integer numbers. • R for REAL; Numeric fields values are shown as real numbers. • F for FIX; Numeric fields values are shown as numbers with a fix number of decimals. • M for MONEY; Numeric fields values are shown as in the money format. • D for DATE; Numeric fields values are shown as dates. • T for TIME; Numeric fields values are shown as times. • TS TIMESTAMP; Numeric fields values are shown as time stamps. • IV for INTERVAL; Numeric fields values are shown as intervals.
qnDec	Number of decimals. Default is 10.	Integer between 0 and 15.
qUseThou	Defines whether or not a thousands separator must be used. Default is 0.	One of: 0 for false 1 for true
qFmt	Defines the format pattern that applies to qText. Is used in connection to the type of the field (parameter qType). For more information, see Struct FieldAttributes. Example: YYYY-MM-DD for a date	String
qDec	Defines the decimal separator. Example: .	String
qThou	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,	String

Name	Description	Type
qSortByState	Sorts the field values according to their logical state (selected, optional, alternative or excluded).	One of: • -1 for sorting descending • 0 for no sorting • 1 for sorting ascending
qSortByFrequency	Sorts the field values by frequency (number of occurrences in the field).	One of: • -1 for sorting ascending • 0 for no sorting • 1 for sorting descending
qSortByNumeric	Sorts the field values by numeric value.	One of: • -1 for sorting descending • 0 for no sorting • 1 for sorting ascending
qSortByAscii	Sorts the field by alphabetical order.	One of: • -1 for sorting descending • 0 for no sorting • 1 for sorting ascending
qSortByLoadOrder	Sorts the field values by the initial load order.	One of: • -1 for sorting descending • 0 for no sorting • 1 for sorting ascending
qSortByExpression	Sorts the field by expression.	One of: • -1 for sorting descending • 0 for no sorting • 1 for sorting ascending
qExpression	Sort by expression.	"qv": "<expression>" Where <expression> is a string.

Name	Description	Type
qDisplayNumberOfRows	This parameter applies to list objects. If the number of selected values in the list object is greater than the value set in qDisplayNumberOfRows, the selected lines are promoted at the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.	Integer

Name

Description

Type

qDisplayNumberOfRows

This parameter applies to list objects.

If the number of selected values in the list object is greater than the value set in qDisplayNumberOfRows, the selected lines are promoted at the top of the list object.

If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

Integer

Name	Description	Type
qLeft	Position from the left. Corresponds to the first column.	Integer
qTop	Position from the top. Corresponds to the first row.	Integer
qWidth	Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer
qHeight	Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer

Name	Description	Type
qExpr	Value of the expression	String
qLibraryId	Refers to an expression stored in the library.	String

Example

"qListObjectDef": { "qStateName": "$", "qLibraryId": "", "qDef": { "qGrouping": "N", "qFieldDefs": [ "Country" ], "qFieldLabels": [ "Country" ], "qSortCriterias": [ { "qSortByState": 0, "qSortByFrequency": 0, "qSortByNumeric": 0, "qSortByAscii": 0, "qSortByLoadOrder": 1, "qSortByExpression": 0, "qExpression": { "qv": "" } } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "", "qDec": ".", "qThou": " " } ] }, "qAutoSortByState": { "qDisplayNumberOfRows": -1 }, "qFrequencyMode": "EQ_NX_FREQUENCY_NONE", "qShowAlternatives": true, "qInitialDataFetch": [ { "qTop": 0, "qLeft": 0, "qHeight": 5, "qWidth": 1 } ] }

In this example, a list object is defined. Its dimension is Country. The sorting by load order is enabled and alternative values are allowed. The initial data fetch will bring the first five values of the dimension Country starting from the top left .

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