Skip to main content Skip to complementary content

SetActiveField method

You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.

Warning noteEXPERIMENTAL.
This API is under development. Do not rely on it. It may change or be removed in future versions.

Parameters

Name Description Mandatory Type
qPath

Path to the definition of the object to be selected. For example, /qHyperCubeDef .

Yes String
qDimNo

Dimension number or index starting from 0. The default value is 0.

Yes Integer
qNewIndex

Index of the field to jump to.

Yes Integer

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 – please let us know!