8.5.5.1.2. pymodaq_gui.plotting.data_viewers.viewer module

class pymodaq_gui.plotting.data_viewers.viewer.ViewerDispatcher(dockarea=None, title='', next_to_dock=None, direction='right')[source]

Bases: object

MixIn class to add easy control for adding multuiple data viewers in docks depending on data to be plotted

Parameters:

  • dockarea (DockArea)

  • title (str)

  • next_to_dock (Dock) – (deprecated) has no effect

  • direction (str) – either ‘right’, ‘left’, ‘bottom’, ‘top’.

Attributes:
viewer_docks
viewer_types
viewer_widgets
viewers

Methods

remove_viewers([Nviewers_to_leave])

Remove viewers from the list after index Nviewers_to_leave

show_data(data, **kwargs)

Convenience method.

update_viewers(viewers_type[, viewers_name, ...])

add_viewer

close
add_viewer(viewer_type, dock_viewer=None, dock_name=None)[source]
close()[source]
remove_viewers(Nviewers_to_leave=0)[source]

Remove viewers from the list after index Nviewers_to_leave

Parameters:

Nviewers

show_data(data, **kwargs)[source]

Convenience method. Display each dwa in a dedicated data viewer

update_viewers(viewers_type, viewers_name=None, force=False)[source]
Parameters:

  • viewers_type (List[Union[str, ViewersEnum]])

  • viewers_name (List[str])

  • force (bool) – if True remove all viewers before update else check if new viewers type are compatible with old ones

property viewer_docks: List[Dock]
property viewer_types: List[ViewersEnum]
property viewer_widgets: List[qtpy.QtWidgets.QWidget]
property viewers: List[ViewerBase]
class pymodaq_gui.plotting.data_viewers.viewer.ViewerFactory[source]

Bases: ObjectFactory

Attributes:
viewers

Methods

get
get(viewer_name, **kwargs)[source]
property viewers
pymodaq_gui.plotting.data_viewers.viewer.create_viewer0D(parent=None, **_ignored)[source]
pymodaq_gui.plotting.data_viewers.viewer.create_viewer1D(parent, **_ignored)[source]
pymodaq_gui.plotting.data_viewers.viewer.create_viewer2D(parent, **_ignored)[source]
pymodaq_gui.plotting.data_viewers.viewer.create_viewerND(parent, **_ignored)[source]
pymodaq_gui.plotting.data_viewers.viewer.get_viewer_enum_from_axes(Naxes)[source]