paraview.simple.
AnnotateGlobalData
(*input, **params)¶Annotate Global Data provides a simpler API for creating text annotations using vtkPythonAnnotationFilter. Instead of users specifying the annotation expression, this filter determines the expression based on the array selected by limiting the scope of the functionality. This filter only allows the user to annotate using “global-data” aka field data and specify the string prefix to use. If the field array chosen has as many elements as number of timesteps, the array is assumed to be “temporal” and indexed using the current timestep.
- Format
- Text that is used as a format string passed to the Python string formatter (% operator). Used to format the data.
- Input
- Set the input of the filter.
- Prefix
- Text that is used as a prefix to the field value.
- SelectArrays
- Choose array that is going to be displayed.
- Suffix
- Text that is used as a suffix to the field value.
- CellData
- Returns cell data information
- FieldData
- Returns field data information
- PointData
- Returns point data information
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Initialize = aInitialize(self, connection=None, update=True)
- FileNameChanged(self)
- Called when the filename of a source proxy is changed.
- GetCellDataInformation(self)
- Returns the associated cell data information.
- GetDataInformation(self, idx=None)
- This method returns a DataInformation wrapper around a vtkPVDataInformation
- GetFieldDataInformation(self)
- Returns the associated cell data information.
- GetPointDataInformation(self)
- Returns the associated point data information.
- UpdatePipeline(self, time=None)
- This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.
- UpdatePipelineInformation(self)
- This method updates the meta-data of the server-side VTK pipeline and the associated information properties
- __getitem__(self, idx)
- Given a slice, int or string, returns the corresponding output port
- GetProperty(self, name)
- Given a property name, returns the property object.
- GetPropertyValue(self, name)
- Returns a scalar for properties with 1 elements, the property itself for vectors.
- InitializeFromProxy(self, aProxy, update=True)
- Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.
- ListProperties(self)
- Returns a list of all property names on this proxy.
- SetPropertyWithName(self, pname, arg)
- Generic method for setting the value of a property.
- __del__(self)
- Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary
- __eq__(self, other)
- Returns true if the underlying SMProxies are the same.
- __getattr__(self, name)
- With the exception of a few overloaded methods, returns the SMProxy method
- __hash__(self)
- Return hash(self).
- __init__(self, **args)
- Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.
- __iter__(self)
- Creates an iterator for the properties.
- __ne__(self, other)
- Returns false if the underlying SMProxies are the same.
- __setattr__(self, name, value)
- Implement setattr(self, name, value).
add_attribute(self, name, value)
For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues