pyvista.DataSet.set_active_scalars#

DataSet.set_active_scalars( name: str | None, preference='cell', ) → tuple[FieldAssociation, ndarray[Any, dtype[float]] | None][source]#

Find the scalars by name and appropriately sets it as active.

To deactivate any active scalars, pass None as the name.

Parameters:

namestr, optional: Name of the scalars array to assign as active. If None, deactivates active scalars for both point and cell data.
preferencestr, default: “cell”: If there are two arrays of the same name associated with points or cells, it will prioritize an array matching this type. Can be either 'cell' or 'point'.

Returns:

pyvista.core.utilities.arrays.FieldAssociation: Association of the scalars matching name.
pyvista_ndarray: An array from the dataset matching name.