Polybench® Reference
Implements a viewer that will show a waterfall plot of the incoming buffers and vectors

Waterfall Plotter

Overview

Provides a similar viewer as the Histo Viewer ("Histo Viewer"), but now displays the vectors in a waterfall plot.

Operator ports

Input V: Specific sample type, see below.

Paired User Interface Object

This operator is loaded simultaneously with a user interface object. The user interface object can be moved to another page, and would normally be displayed in the end-user application. The operator and this user interface object can never be separated. If you delete the operator, the user interface is deleted automatically as well. Note that you cannot delete the user interface, only the operator symbol!

Properties

Find more information about changing properties here: "Properties Viewer"

TicksCountX
type: Integer value
Number of grid ticks on the X axis


BufferLength
type: Integer value
The amount of samples that will be stored, and which will be redrawn when, for instance, the viewer is zoomed.


TraceCount
type: See description
The maximum amount of buffers and vectors that will be displayed on the viewer at one time.


StartHeight (%)
type: Integer value
The height, in percentage of full height, where the waterfall will start to fall down


VectorScale (%)
type: Integer value
The room that one vector will get.


TickMultiplicationFactor
type: Real value
The factor with which the tick values on the x axis will be multiplied.


TickOffset
type: Real value
This value will be added to the tick values on the x axis.


BackgroundColor
type: Known color name
The color of the background.

This property uses the Color Repository. For more information about the use of colors in a project, refer to "Color Repository"

ForegroundColor
type: Known color name
The color of the title, axes and other lines around the graph.

This property uses the Color Repository. For more information about the use of colors in a project, refer to "Color Repository"

GridColor
type: Known color name
The color of the grid or markings.

This property uses the Color Repository. For more information about the use of colors in a project, refer to "Color Repository"

SelectionColor
type: Known color name
The color for channel selections.

This property uses the Color Repository. For more information about the use of colors in a project, refer to "Color Repository"

OuterBorderName
type: See description
Select a style for the outer border of the viewer.


InnerBorderName
type: See description
Select a style for the border of the panel where the viewer contents or graph is drawn.


Title
type: See description
The title above the graph.


Y_Label
type: See description
The label along the Y-axis.


Y_LabelVisible
type: True or False
Set to False to disable the label along the Y-axis
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


X_Label
type: See description
The label along the X-axis.


X_LabelVisible
type: True or False
Set to False to disable the label along the X-axis
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


FontTitle
type: Known text font name
The text font of the title (select from the Font repository).

This property uses the Font Repository. For more information about the use of text fonts in a project, refer to "Font Repository"

FontMetaData
type: Known text font name
The text font of all meta data, such as channel names (select from the Font repository).

This property uses the Font Repository. For more information about the use of text fonts in a project, refer to "Font Repository"

FontContents
type: Known text font name
The text font of values and labels of the shown contents or graph (select from the Font repository).

This property uses the Font Repository. For more information about the use of text fonts in a project, refer to "Font Repository"

SingleBaseline
type: True or False
Set this value to 'true' if you want all the signals to be drawn around one baseline.
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


AllowChannelSelect
type: True or False
If true, the user is able to select channels by clicking one or more channel names.
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


AllowZooming
type: True or False
Set to true if the end-user is allowed to change the time range from within the viewer, by scrolling the scroll wheel of the mouse.
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


NumberFormat
type: See description
Determines how values are displayed in the viewer. Examples: ',2' (decimal comma), '.3' (decimal dot), ';1' (decimal comma or dot). This only regulates sample values, not time labels.


BackgroundImage
type: Known image name
The name of the background image. The image name can be selected from the Image Repository (press the small button).

This property uses the Image Repository. For more information about the use of images in a project, refer to "Image Repository"

Caption
type: Word or phrase
The name of the object in the project. This name must not contain '.', '$' nor '@' characters.

For more information about the rules and usage of the Caption property, please refer to "Caption property - background and usage".

Documentation
type: See description
Optional documentation of this object. If this object is an operator, the Documentation text is displayed below the operator symbol.


Extra dialog to change properties of this object: Layout

Details

User Interface Object on Printable Pages

The user interface of this component will be printed on a report, if it is put on a Printable Page (see "Page").

Behaviour in relation to the data cursor in reviewed data

This object reacts on a change of the central Data Cursor of a group of synchronized objects. This means that if this object has the same SyncID as the object that changes the Data Cursor, then this object will change its state accordingly. For more information see also: "Data Cursor and the use of SyncID".