pop_dims#

ReferenceIndices.pop_dims(*dims)[source]#

Remove slider dims, i.e. unregister their reference ranges.

A dim can only be removed once no NDGraphic uses it as a slider dim, since its reference range and current index are what those graphics are sliced with. Delete those graphics first using nd_subplot.delete_nd_graphic(). Every given dim is checked before any of them are removed, so nothing is removed if one of them is still in use. The slider for each removed dim is also removed from the UI of every NDWidget managed by this ReferenceIndex.

Parameters:

dims (str) – names of the dims to remove

Returns:

the removed reference ranges, {dim_name: range}, can be passed back to push_dims()

Return type:

dict[str, RangeContinuous | RangeDiscrete]

Raises:

  • KeyError – if a given dim has no reference range in this ReferenceIndex

  • ValueError – if an NDGraphic still uses one of the given dims as a slider dim