Skip to content

← visualization package

MarkerTablePlot

Display event markers and their timestamps in a real-time table.

Markers are buffered as they arrive and the most recent ones are shown (see max_rows property). The table can be displayed in a standalone window or fed into a Plot Dashboard node via the figure output. (In the latter case, suppress_window should be set to True.). Version 1.0.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 plot window. The placeholders $(streamname), $(sourceid), and $(sourceurl) can be used here.

verbose name
Title
default value
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]. If x, y are set to 0 each, then the window will appear in the top left corner of the current screen.

verbose name
Window Position
default value
[50, 50, 1000, 800]
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 table in Hz. Limits how often the matplotlib canvas is repainted (and how often a Plot Dashboard re-renders this table panel). 0 means no throttle. Lowering this can significantly reduce visualization overhead where matplotlib.table draws are expensive (i.e., MacOS).

verbose name
Max Redraw Rate (Hz)
default value
2.0
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

data

Data to display.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
IN

precision

Number of decimal places for timestamp values.

verbose name
Precision
default value
2
port type
IntPort
value type
int (can be None)

max_rows

Maximum number of markers to display.

verbose name
Max Rows
default value
32
port type
IntPort
value type
int (can be None)

every_n_ticks

Only update the table every N ticks. Use this to reduce rendering overhead.

verbose name
Every N Ticks
default value
1
port type
IntPort
value type
int (can be None)

header_color

Background color of the column headers.

verbose name
Header Color
default value
#505050
port type
StringPort
value type
str (can be None)

row_height

Row height multiplier. Increase to add more vertical spacing between rows.

verbose name
Row Height
default value
1.5
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)