DataSet.set_active_vectors

DataSet.set_active_vectors#

DataSet.set_active_vectors(
name: str | None,
preference: PointLiteral | CellLiteral | FieldAssociation = 'point',
) → None[source]#

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

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

Parameters:
namestr, optional

Name of the vectors array to assign as active.

preferencestr | pyvista.core.utilities.arrays.FieldAssociation, default: “point”

If there are two arrays of the same name associated with points, cells, or field data, it will prioritize an array matching this type. Can be either 'cell', 'field' or 'point', or the matching FieldAssociation member.