rqt_robot_dashboard.dashboard module

class rqt_robot_dashboard.dashboard.Dashboard(*args: Any, **kwargs: Any)

Bases: Plugin

Base class from which dashboards should inherit.

Parameters:

context (qt_gui.plugin.Plugin) – the plugin context

add_widgets()

Add groups of widgets to _main_widget. Supports group labels.

This method can be reimplemented in order to customize appearances.

get_widgets()

Most of the dashboard customization should be done here. If this function is not overriden the dashboard will display nothing.

Returns:

List of lists containing dashboard widgets, or list of lists containing a string followed by a list of dashboard widgets.

setup(context)

Called during __init__ Subclasses should do initialization here.

NOTE when overriding this method you should provide a self.name to avoid naming conflicts.

Parameters:

context (qt_gui.plugin.Plugin) – The plugin context

shutdown_dashboard()

Called after shutdown plugin, subclasses should do cleanup here, not in shutdown_plugin

shutdown_plugin()

Called when the toolbar is closed by Qt.