Overview
Retrieves the values of a list object.
Parameters
| Name | Description | Type |
|---|---|---|
| qPath |
Path to the definition of the object to be selected. For example, /qListObjectDef. |
String |
| qPages | Array of pages you are interested in. |
Array of NxPage See NxPage |
| 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 |
Outputs
A data set is returned.
| Name | Description | Type |
|---|---|---|
| qDataPages | A data set. |
Array of NxDataPage See NxDataPage |
| Name | Description | Type |
|---|---|---|
| qMatrix | Array of data. |
Array of NxCellRows |
| qTails |
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ]. |
Array of NxGroupTail |
| qArea | Size and offset of the data in the matrix. | Rect |
| qIsReduced |
Is set to true, if the data have been reduced. The default value is false. |
Boolean |
| Name | Description | Type |
|---|---|---|
| NxCellRows | Array of data. |
Array of NxCell |
| Name | Description | Type |
|---|---|---|
| qUp |
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight This parameter is optional. Is not shown if the value is 0. |
Integer |
| qDown |
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight This parameter is optional. Is not shown if the value is 0. |
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 |
|---|---|---|
| qText |
Some text. This parameter is optional. |
String |
| qNum |
A value. This parameter is optional. |
Double precision floating point |
| qElemNumber |
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
|
Integer |
| qState |
State of the value. The default state for a measure is L. |
One of:
|
| qIsEmpty |
Is set to true, if qText and qNum are empty. This parameter is optional. The default value is false. |
Boolean |
| qIsTotalCell |
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false. Not applicable to list objects. |
Boolean |
| qIsOtherCell |
Is set to true if the cell belongs to the group Others. Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp. This parameter is optional. The default value is false. Not applicable to list objects. |
Boolean |
| qFrequency |
Frequency of the value. This parameter is optional. |
String |
| qHighlightRanges |
Search hits. The search hits are highlighted. This parameter is optional. |
Null or NxHighlightRanges |
| qAttrExps | Attribute expression values. |
Null or NxAttributeExpressionValues |
| qIsNull | Is set to true if the value is Null. | Boolean |
| Name | Description | Type |
|---|---|---|
| qRanges | Ranges of highlighted values | Array of CharRange |
| Name | Description | Type |
|---|---|---|
| qCharPos | Position of the first search occurrence | Integer |
| qCharCount | Number of occurrences found | Integer |
| Name | Description | Type |
|---|---|---|
| qValues | List of attribute expressions values. | Array of NxSimpleValue |
| Name | Description | Type |
|---|---|---|
| qText |
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric. |
String |
| qNum |
Numeric value of the attribute expression. This property is set to NaN (Not a Number) if the attribute expression value is not a numeric. Numerical values are not returned as text. |
Double precision floating point |
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!