Skip to content

← visualization package

ScrollPlot

Plot a multi-channel continuous time series in a scrollable plot offline.

This node accepts a full length data set using an adjustable window size. The node requires that the data has a time axis, and either a space (channels) or a feature axis. All other axes (e.g., frequency) are folded into a flat space axis. For better viewing, this node supports removing the mean of the data so that the signals are centered and can autoscale the values. Centering and shifting time to start at 0 are enabled by default. To remove drift or a DC offset it is recommended to use a high-pass filter before using this node. Lines can be toggled on and off by clicking their label names in the y-axis. This node also provides keyboard shortcuts for changing the scale (+ and -) as well as scrolling through the plot (left and right arrows, page down and up). The toolbar can be toggled on and off with 't', and the markers can be toggled on and off with 'm' (only if plot_markers is True). Version 2.0.3

Ports/Properties

data

Data to display.

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

stream

Name of stream to display. The first stream whose name starts with this string is displayed.

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)

scale

Data scale. Increasing this value will magnify the plot curves correspondingly.

verbose name
Data Scaling
default value
1.0
port type
FloatPort
value type
float (can be None)

time_range

Time range (in seconds) to display.

verbose name
Time Range To Display
default value
10.0
port type
FloatPort
value type
float (can be None)

title

Title of the plot. This is the title of the plot window. Placeholders like $(streamname) or $(sourceid) can be used here.

verbose name
Title Of Plot Window
default value
Time series view
port type
StringPort
value type
str (can be None)

figure_background_color

Background color for figure window. This can be hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Figure Background Color
default value
darkgray
port type
StringPort
value type
str (can be None)

plot_background_color

Background color for inside subplot. This can be hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Plot Background Color
default value
gainsboro
port type
StringPort
value type
str (can be None)

line_color

Color of the graph curves. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('blue'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Line Color
default value
mediumblue
port type
StringPort
value type
str (can be None)

auto_line_colors

Automatically assign a different color to each line. Will take precedence over the line_color property.

verbose name
Auto Line Colors
default value
False
port type
BoolPort
value type
bool (can be None)

colormap

If using auto line colors, the color for each line will be spaced evenly using the desired colormap.

verbose name
Colormap
default value
brg
port type
EnumPort
value type
str (can be None)

zero_color

Color of the zero line. The zero line is a dim line that shows where zero would be for a given channel. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Zero Color
default value
#7F7F7F
port type
StringPort
value type
str (can be None)

decoration_color

Color of the axis decorations. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Decoration Color
default value
black
port type
StringPort
value type
str (can be None)

plot_markers

Display markers if enabled. Note it is recommended to remove extraneous markers using SelectInstances node before plotting or the below "markers to show" parameter for faster loading and smoother scrolling. This can be toggled off by pressing 'm'.

verbose name
Plot Markers For Viewing
default value
True
port type
BoolPort
value type
bool (can be None)

markers_to_show

Display only event markers that are specified in a list of string names. If empty, all markers will be displayed. Limit the marker set for faster loading and smoother scrolling.

verbose name
Markers To Show
default value
[]
port type
ListPort
value type
list (can be None)

marker_color

Color of vertical lines for marker events. Either a string or a dictionary that represents a mapping from event type to color (the special key '*' stands for all other markers).

verbose name
Marker Color
default value
crimson
port type
Port
value type
object (can be None)

marker_text_alignment

Alignment of event marker annotation text to either top or bottom of plot.

verbose name
Marker Text Alignment
default value
top
port type
EnumPort
value type
str (can be None)

line_width

Line width for plotting.

verbose name
Line Width
default value
0.75
port type
FloatPort
value type
float (can be None)

font_size

Font size (in points) of the x and y axis tick labels.

verbose name
Font Size
default value
12.0
port type
FloatPort
value type
float (can be None)

titles_color

Color of the title and x-axis label. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('black'). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

verbose name
Titles Color
default value
black
port type
StringPort
value type
str (can be None)

zeromean

Display data with mean corrected to zero. This makes sure that each channel is centered for better viewing. If this is disabled, your data may be outside the window, especially if you have not performed high-pass filtering on your signal. Enabling this may make the curves appear to shift up or down if their mean is not already zero.

verbose name
Center (Zero-Mean) Channels For Viewing
default value
True
port type
BoolPort
value type
bool (can be None)

autoscale

Automatically scale channels to a standard scale. This makes sure that channels are rescaled such that they fit comfortably in the drawing area. All channels are rescaled by the same scale factor. Enabling this may make the curves appear to change scale suddenly, especially when large artifacts come into view or go out of view.

verbose name
Autoscale Data For Better Viewing
default value
True
port type
BoolPort
value type
bool (can be None)

t0_is_zero

Count time from zero. If set to False, the time starts at whatever is the first time stamp in the data.

verbose name
T0 Is Zero
default value
True
port type
BoolPort
value type
bool (can be None)

antialiased

Draw graphics antialiased. If enabled, the lines will appear less pixelated or 'jaggy', however, this can slow down plotting.

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

downsampled

Draw downsampled graphics. This will reduce the sampling rate (i.e., time resolution) of the data if the display time range or sampling rate is so high that one sample would be shorter than a pixel on the screen. This can speed up plotting in such cases. WARNING: some versions of the underlying graphics library crash with this option enabled, so using this is not recommended unless absolutely necessary.

verbose name
Downsample Curves For Performance
default value
False
port type
BoolPort
value type
bool (can be None)

nans_as_zero

Show NaN values as zero.

verbose name
Nans As Zero
default value
False
port type
BoolPort
value type
bool (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, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

verbose name
Initial Window Position
default value
[100, 50, 1200, 900]
port type
ListPort
value type
list (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
Always On Top
default value
False
port type
BoolPort
value type
bool (can be None)

override_srate

Optionally override sampling rate to speed up plotting.

verbose name
Override Srate
default value
None
port type
FloatPort
value type
float (can be None)

show_toolbar

Whether to show the window toolbar. This can be toggled on or off by pressing 't'.

verbose name
Show Toolbar
default value
True
port type
BoolPort
value type
bool (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)