qListObjectDef

A list object is a visualization that contains one dimension. When getting the layout of a list object (qListObjectDef), all values are rendered. If selections are applied to a list object, the selected values are displayed along with the excluded and the optional values.

Just like you can have multiple hypercubes in your properties, you can also have multiple list objects. If you have multiple list objects, you need to place them at different paths in your property structure.

Examples

Example: List object definition in List template

initialProperties: {
	version: 1.0,
	qListObjectDef: {
		qShowAlternatives: true,
		qFrequencyMode: "V",
		qInitialDataFetch: [{
			qWidth: 2,
			qHeight: 50
		}]
	}
},

Properties

Name	Type	Description
qStateName	String	Name of the alternate state. Default is $ (current selections).
qLibraryId	String	Refers to a dimension stored in the library.
qDef	Null or NxInlineDimensionDef	Refers to a dimension stored in the list object.
qAutoSortByState	Null or NxAutoSortByStateDef.	Defines the sorting by state.
qFrequencyMode	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.	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.
qShowAlternatives	Boolean	If set to true, alternative values are allowed in qData. This parameter is optional. Default value is true. If set to false, no alternative values are displayed in qData. Instead, values are excluded. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values.
qInitialDataFetch	Array of NxPage	Initial data set. See: NxPage.
qExpressions	Array of NxListObjectExpressionDef.	Lists the expressions in the list object. This parameter is optional.

NxInlineDimensionDef

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

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

Name	Type	Description
qType	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.	Type of the field. Default is U.
qnDec	Integer between 0 and 15.	Number of decimals. Default is 10.
qUseThou	One of: 0 for false 1 for true	Defines whether or not a thousands separator must be used. Default is 0.
qFmt	String	Defines the format pattern. Is used in connection to the type of the field (parameter qType) Example:YYYY-MM-DD for a date.
qDec	String	Defines the decimal separator. Example:.
qThou	String	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example:,

NxAutoSortByStateDef

Name	Type	Description
qDisplayNumberOfRows	Integer	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

Name

Type

Description

qDisplayNumberOfRows

Integer

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

NxPage

Name	Type	Description
qLeft	Integer	Position from the left. Corresponds to the first column.
qTop	Integer	Position from the top. Corresponds to the first row
qWidth	Integer	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).
qHeight	Integer	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).

NxListObjectExpressionDef

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

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