simple.widget Module

paraview.simple.widget.GetScalarBar(ctf, view=None)

Returns the scalar bar for the given color transfer function in the given view.

Parameters

• ctf (Color transfer function proxy.) – The color transfer function proxy whose scalar bar representation should be returned.

• view (View proxy.) – View from which the scalar bar proxy should be retrieved. Optional, defaults to the active view, if possible.

Returns

The scalar bar proxy for the color transfer function if found. his will either return an existing scalar bar or create a new one.

Return type

Scalar bar proxy

paraview.simple.widget.HideInteractiveWidgets(proxy=None)

If possible in the current environment, this function will request the application to hide the interactive widget(s) for the given proxy.

Parameters

proxy (Source proxy.) – The proxy whose associated interactive widgets should be hidden. Optional, if not provided the active source’s widgets are hidden.

paraview.simple.widget.HideScalarBarIfNotNeeded(lut, view=None)

Hides the given scalar bar if it is not used by any of the displayed data.

Parameters

• lut (Scalar bar proxy) – The lookup table (lut) or scalar bar proxy

• view – The view in which the scalar bar should be hidden. Optional, defaults to hiding scalar bars in the active view.

paraview.simple.widget.HideUnusedScalarBars(view=None)

Hides all unused scalar bars from the view. A scalar bar is used if some data is shown in that view that is coloring using the transfer function shown by the scalar bar.

Parameters

view (View proxy) – View in which unused scalar bars should be hidden. Optional, defaults to the active view.

paraview.simple.widget.ShowInteractiveWidgets(proxy=None)

If possible in the current environment, this function will request the application to show the interactive widget(s) for the given proxy.

Parameters

proxy (Source proxy.) – The proxy whose associated interactive widgets should be shown. Optional, if not provided the active source’s widgets are shown.

paraview.simple.widget.UpdateScalarBars(view=None)

Hides all unused scalar bars and shows used scalar bars. A scalar bar is used if some data is shown in that view that is coloring using the transfer function shown by the scalar bar.

Parameters

view (View proxy) – The view in which scalar bar visibility should be changed. Optional, defaults to using the active view.

paraview.simple.widget.UpdateScalarBarsComponentTitle(ctf, representation=None)

Update the component portion of the title in all scalar bars using the provided lookup table. The representation is used to recover the array from which the component title was obtained.

Parameters

• ctf (Transfer function proxy.) – The lookup table that the scalar bar represents. Optional, defaults to the representation of the active source in the active view.

• representation (Representation proxy) – If provided, it is the representation to use to recover the array that provides the component title portion. Optional, defaults to the active representation.

Returns

True if operation succeeded, False otherwise.

Return type

bool