← visualization package

PlotDashboard

Display multiple plots side by side in a single Qt window.

Connect the figure output of visualization nodes to the figure inputs of this node. The source nodes should have their suppress_window property enabled. This node currently supports outputs from the following nodes: TimeSeriesPlot, BarPlot, TopoPlotViewer, SpectrumPlot, TablePlot. supress_window should be set to True in those nodes when connected to this node. Version 1.1.0

Ports/Properties

stream

Name of stream to plot. Wildcards are supported, i.e. mystream* will plot the first stream whose name starts with mystream.

• verbose name: Select Stream To Display
• default value: None
• port type: StringPort
• value type: str (can be None)

stream_name

• verbose name: Stream Name
• default value: None
• port type: AliasPort
• value type: str (can be None)

max_channels

Max number of channels to display at once. Note that a large number of channels can slow the plot down considerably, and is not recommended. Alternatively, instead of increasing this, use the PgUp/PgDn (or u/d) keys in the plot window to show the prev/next set of n channels (where n is this number).

• verbose name: Max Channels To Plot
• default value: 32
• port type: IntPort
• value type: int (can be None)

auto_line_colors

Automatically assign a different color to each line or bar. Takes precedence if selected. See colormap property to determine the color selection.

• verbose name: Auto Assign Colors
• default value: True
• port type: BoolPort
• value type: bool (can be None)

colormap

Colormap to use for auto assign colors. (See matplotlib online documentation for colormap examples.)

• verbose name: Colormap
• default value: gist_rainbow
• port type: EnumPort
• value type: str (can be None)

background_color

Background color. This can be hexadecimal (hex) notation (#RRGGBB) or CSS named colors ('white'). One resource (among many) that provides a list of both hex and CSS named colors is https://www.w3.org/wiki/CSS/Properties/color/keywords.

• verbose name: Background Color
• default value: #303030
• port type: StringPort
• value type: str (can be None)

decoration_color

Color of the axis labels and ticks. (See background_color description for details.).

• verbose name: Decoration Color
• default value: #B0B0B0
• port type: StringPort
• value type: str (can be None)

plot_minmax

Display min and max values of original data irrespective of scaling.

• verbose name: Show Data Min/max Values
• default value: False
• port type: BoolPort
• value type: bool (can be None)

title

Title of the dashboard window.

• verbose name: Title
• default value: Dashboard
• port type: StringPort
• value type: str (can be None)

initial_dims

Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, height].

• verbose name: Window Position
• default value: [0, 0, 1920, 1040]
• port type: ListPort
• value type: list (can be None)

left_offset

Left offset of the window on the monitor. The x value in the initial window position property will be increased by this amount. Use this to shift all plots to a second monitor, for example. May be a negative number (i.e., to move plots to a window to the left).

• verbose name: Left Offset
• default value: 0
• port type: IntPort
• value type: int (can be None)

show_toolbar

Show the window toolbar (which provides some additional functions).

• verbose name: Show Toolbar
• default value: False
• port type: BoolPort
• value type: bool (can be None)

always_on_top

Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

• verbose name: Display Window Always On Top
• default value: False
• port type: BoolPort
• value type: bool (can be None)

tight_layout

Reduce the amount of white space around the plot within the window.

• verbose name: Tight Layout
• default value: True
• port type: BoolPort
• value type: bool (can be None)

font_size

Font size (in points) of text plotted outside the plot axes, such as axis labels, legend, etc.

• verbose name: Font Size
• default value: 11
• port type: FloatPort
• value type: float (can be None)

annotation_font_size

Font size (in points) for text which appear inside the plot axes, such as markers, scale, etc.

• verbose name: Annotation Font Size
• default value: 11
• port type: FloatPort
• value type: float (can be None)

antialiased

Draw graphics antialiased. If set to False, lines will appear more pixelated or 'jaggy', but plotting should render faster.

• verbose name: Draw Antialiased Lines
• default value: True
• port type: BoolPort
• value type: bool (can be None)

max_redraw_hz

Maximum redraw rate of this plot in Hz. Limits how often the matplotlib canvas is repainted (and, when the plot feeds a Plot Dashboard, how often the dashboard re-renders the corresponding panel). None means use the Plot Dashboard's default for downstream panels and no throttle for this node's own window. 0 means no throttle (legacy behavior, draw on every tick). A positive value is the upper bound on the redraw rate. Reducing this is particularly useful for nodes whose draw is expensive (e.g. matplotlib tables, which are heavy on macOS due to CoreText).

• verbose name: Max Redraw Rate (Hz)
• default value: None
• port type: FloatPort
• value type: float (can be None)

line_color

Color of the lines. (See background_color description for details.)

• verbose name: Line Color
• default value: white
• port type: StringPort
• value type: str (can be None)

zero_color

Color of the grid lines. (See background color description for details.)

• verbose name: Zero Color
• default value: #606060
• port type: StringPort
• value type: str (can be None)

line_width

Width of the lines (or bars).

• verbose name: Line Width
• default value: 1.25
• port type: FloatPort
• value type: float (can be None)

label_rotation

Orientation of plot Y axis tick labels.

• verbose name: Label Rotation
• default value: horizontal
• port type: EnumPort
• value type: str (can be None)

x_label

Label for the X axis. Leave empty to automatically use a suitable default.

• verbose name: X Label
• default value:
• port type: StringPort
• value type: str (can be None)

y_label

Label for the Y axis. Leave empty to automatically use a suitable default.

• verbose name: Y Label
• default value:
• port type: StringPort
• value type: str (can be None)

verbose

Print additional information such as if the incoming packet has no data to plot, etc.

• verbose name: Verbose
• default value: False
• port type: BoolPort
• value type: bool (can be None)

track_window_position

Track the window position and print the new position in the console. This is useful for setting the window position property.

• verbose name: Track Window Position
• default value: False
• port type: BoolPort
• value type: bool (can be None)

suppress_window

Suppress the display window. When enabled, the node will not open a plot window; use this when feeding the figure output into a Plot Dashboard node.

• verbose name: Suppress Window
• default value: False
• port type: BoolPort
• value type: bool (can be None)

figure_out

Plot data for PlotDashboard (PlotData).

• verbose name: Figure Out
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: OUT

figure1

Plot data input 1.

• verbose name: Figure1
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure2

Plot data input 2.

• verbose name: Figure2
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure3

Plot data input 3.

• verbose name: Figure3
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure4

Plot data input 4.

• verbose name: Figure4
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure5

Plot data input 5.

• verbose name: Figure5
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure6

Plot data input 6.

• verbose name: Figure6
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure7

Plot data input 7.

• verbose name: Figure7
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure8

Plot data input 8.

• verbose name: Figure8
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure9

Plot data input 9.

• verbose name: Figure9
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure10

Plot data input 10.

• verbose name: Figure10
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure11

Plot data input 11.

• verbose name: Figure11
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure12

Plot data input 12.

• verbose name: Figure12
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure13

Plot data input 13.

• verbose name: Figure13
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure14

Plot data input 14.

• verbose name: Figure14
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure15

Plot data input 15.

• verbose name: Figure15
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure16

Plot data input 16.

• verbose name: Figure16
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure17

Plot data input 17.

• verbose name: Figure17
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure18

Plot data input 18.

• verbose name: Figure18
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure19

Plot data input 19.

• verbose name: Figure19
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

figure20

Plot data input 20.

• verbose name: Figure20
• default value: None
• port type: DataPort
• value type: object (can be None)
• data direction: IN

columns

Number of columns in the grid layout.

• verbose name: Columns
• default value: 3
• port type: IntPort
• value type: int (can be None)

default_max_redraw_hz

Default maximum per-panel redraw rate in Hz. Used as a fallback for inputs that did not specify their own max_redraw_hz. Set to 0 to disable the throttle (every tick redraws every panel; this can be computationally expensive esp. on MacOS); set higher when the dashboard is showing few/light panels and a higher redraw rate is desired. Per-panel max_redraw_hz values from upstream always take precedence when set.

• verbose name: Default Panel Redraw Rate (Hz)
• default value: 10
• port type: FloatPort
• value type: float (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

• verbose name: Set Breakpoint (Debug Only)
• default value: False
• port type: BoolPort
• value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

• verbose name: Metadata
• default value: {}
• port type: DictPort
• value type: dict (can be None)