Skip to main content Skip to complementary content

StepCycle method

You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling 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
qNbrSteps

Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken.

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!