Technical Reference:Visualization Properties
Visualization properties are properties bound to visualization windows. Currently, the following visualization properties are defined:
Window Properties
Top, Left, Width, Height (number)
Position and size of the visualization window on the virtual desktop.
WindowTitle (string)
The visualization window's title.
WindowFrame (boolean)
Whether to display the visualization window with a title bar, and a resizable window frame. If the window is embedded in a parent window (see PlacementVis), this property defines whether the window title is displayed above the window's content inside the parent window.
FontSize (number)
The font size used within the visualization window.
Visible (boolean)
Whether the window is visible or not.
Graph Options
MinValue, MaxValue (number)
The minimum and maximum expected signal value in raw units (microvolts for signal windows). This value is used to determine the signal's default scaling.
MinValues, MaxValues (list of numbers)
May be used to specify MinValue and MaxValue settings individually for channels. The list is separated by white space, and enclosed in curly braces.
NumSamples (number)
The number of samples displayed in the visualization window.
ChannelGroupSize (number)
The number of subsequent channels that share a common signal baseline.
GraphType (number)
Polyline (9) or Field2d (12). Polyline stands for the standard multi-channel signal view, while Field2d defines a two-dimensional field with color-encoded values.
ShowBaselines (boolean)
For a Polyline display, switches baselines on or off.
ShowNumericValues (boolean)
Whether to display the current value as a number in front of the graphic representation.
ChannelColors (list of hex values)
For a Polyline display, defines the list of colors to be used for drawing signals. The list is enclosed in curly braces as in { 0xff0000, 0x00ff00, 0x0000ff }.
ChannelStyles (string)
For a Polyline display, a string containing characters to plot at sample points, '-' for line, '°' for empty dot, '*' for asterisk, etc. If the string contains fewer characters than there are channels to display, '-' is assumed for the remaining channels.
ValueColors (string)
For a Field2d display, defines the colors used to plot signal values. The string has the form "{ <val1> <red1> <green1> <blue1> } ..." with rgb values ranging from 0 to 255.
AutoScale (boolean)
Select/deselect auto scale option.
FixedScale (boolean)
If true, user cannot adjust value scaling.
HPFilter, LPFilter, NotchFilter (string)
Apply a high pass, low pass, or notch filter to the displayed signal. This does not affect signal processing within the pipeline. To disable a filter, specify "off", to set the filter corner to a certain value, specify the the frequency with unit, e.g. "30Hz".
Units
SampleUnit (string)
The difference between two subsequent sample positions, given as a number followed by a unit, such as 1.4ms. This is used to display units on the x axis of the visualization window.
ChannelUnit (string)
If the channel dimension is a continuous variable, then this property gives the difference between two subsequent channels, as a number followed by unit, such as 2Hz. This is used to display units on the y axis of the visualization window, and currently only used with Field2d type graphs.
ValueUnit (string)
The value of one unit for the values displayed in a visualization window, such as 2muV. This property is used to display value units in Polyline type graphs.
Memo Options
NumLines (number)
The number of lines in a visualization window of type "memo".
Label Lists
ChannelLabels (list of strings)
A list of strings specifying channel labels. Channel labels are displayed to the left of channel traces in Polyline graphs.
GroupLabels (list of strings)
A list of strings specifying a label for each channel group. Channel groups consist of a number of channels displayed on a single baseline.
Marker Lists
XAxisMarkers (list of {number,string} pairs)
A list of position, label pairs that define markers on the X axis.
The number specifies the marker's location in raw units; use the associated signal's ElementUnit property in order to convert from physical units to raw units.
The string may specify up to 4 marker properties, separated by a pipe character (|):
- A textual label displayed at the marker's position below its axis,
- a color name, or an RGB value in hexadecimal format, preceded with a hash character (#),
- a line style specification in ASCII format, consisting of dot and minus characters,
- a line width factor relative to the marker's tick width at the axis.
The following table lists some examples of valid marker definition strings:
"" |
A white marker which will consist of a mark at the marker's axis. |
"Marker" |
A white marker which will consist of a mark at the marker's axis, and a caption. |
"|green" |
A green marker which will consist of a mark at the marker's axis. |
"|#00ff00" |
A green marker which will consist of a mark at the marker's axis. |
"|red|-" |
A red marker which will consist of a mark at the marker's axis, and a vertical red line. |
"Marker|yellow|-.|0.5" |
A yellow marker which will consist of a mark at the marker's axis, a caption, and a vertical dash-dotted yellow line which is 0.5 units wide. |
YAxisMarkers (list of {number,string} pairs)
A list of position, label pairs that define markers on the Y axis.
The number specifies the marker's location in raw units; use the associated signal's ValueUnit property in order to convert from physical units to raw units.
As for XAxisMarkers, the label string may be used to specify an extended format for a marker (see above).
Miscellaneous
ShowXTicks (boolean)
Whether to display ticks on the x axis, and associated labels.
ShowYTicks (boolean)
Whether to display ticks on the y axis, and associated labels.
ShowSampleUnit (boolean)
Switches sample unit display on or off for graphs.
ShowChannelUnit (boolean)
Switches channel unit display on or off for Field2d graphs.
ShowValueUnit (boolean)
Switches value unit display on or off for Polyline graphs.
SampleOffset (number)
An offset, in raw units, which to add to the displayed values on the X axis.
InvertedDisplay (boolean)
Switches between white-on-black and black-on-white display for Polyline graphs.