set_dim_index#

ReferenceIndices.set_dim_index(dim, index, cancel_awaiting=False)[source]#

Set the index for a single dimension and trigger an update.

Parameters:

  • dim (str) – Dimension name.

  • index (int or float) – New reference-space value for this dimension.

  • cancel_awaiting (bool, default False) – If True, cancel any in-progress fetch tasks before scheduling a new one. Used only for fast inputs, currently only for the imgui slider so every single intermediate position during a slider drag isn’t fetched & rendered. All other methods of fetching data (play, step buttons, LinearSelector, programmatic updates) use cancel_awaiting=False to display every data fetch.