IGenericObjectSelectHyperCubeCells Method |
Makes selections in multiple dimensions and measures.
This method applies to hypercubes, such as bar charts, tables and scatter plots.
Namespace: Qlik.EngineAssembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax bool SelectHyperCubeCells(
string path,
IEnumerable<int> rowIndices,
IEnumerable<int> colIndices,
bool softLock = false,
bool deselectOnlyOneSelected = false
)
Function SelectHyperCubeCells (
path As String,
rowIndices As IEnumerable(Of Integer),
colIndices As IEnumerable(Of Integer),
Optional softLock As Boolean = false,
Optional deselectOnlyOneSelected As Boolean = false
) As Boolean
Parameters
- path
- Type: SystemString
Path to the definition of the object to be selected.
For example, /qHyperCubeDef.
This parameter is mandatory. - rowIndices
- Type: System.Collections.GenericIEnumerableInt32
Array of row indexes to select, starting from 0.
If the array is empty [ ], all rows are selected.
This parameter is mandatory. - colIndices
- Type: System.Collections.GenericIEnumerableInt32
Indexes of the columns to select, starting from 0.
A column corresponds to a dimension or a measure depending on the definition of the hypercube.
Example:
If the hypercube has two dimensions and one measure:
[0] selects the first column (i.e the first dimension)
[1] selects the second column (i.e the second dimension)
[2] selects the third column (i.e the measure)
If the array is empty [ ], all columns are selected.
This parameter is mandatory. - softLock (Optional)
- Type: SystemBoolean
Set to true to ignore locks; in that case, locked fields can be selected.
This parameter is mandatory. - deselectOnlyOneSelected (Optional)
- Type: SystemBoolean
Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.
The default value is false.
Return Value
Type:
BooleanSee Also