addDivider

System object: dsp.LogicAnalyzer
Package: dsp

Add divider to display

Syntax

dividerTag = addDivider(H)
dividerTag = addDivider(H,'Name',Value)

Description

dividerTag = addDivider(H) adds in a divider to the display. A tag value is returned, which can be used to modify and delete the divider.

dividerTag = addDivider(H,'Name',Value) adds in a divider to the display with each specified property Name set to the specified value. You can specify NameValue arguments in any order.

Input Arguments

expand all

H — The Logic Analyzer object to which you want to add a dividerdsp.LogicAnalyzer object

Example: 'addDivider(H)' adds a divider with the default characteristics.

Example: 'H.addDivider()' adds a divider with the default characteristics.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'DisplayChannel',2,'Name','MyDivider' specifies that a divider should be added to display channel 2 and named "MyDivider".

'DisplayChannel' — Channel on the display that shows this dividerNumInputPorts (default) | scalar numeric value in the range (1,NumInputPorts)

Specify as a scalar numeric value the display channel that shows this divider. By default, the divider is added to the end of the display.

Example: 'DisplayChannel',2

Data Types: double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

'Height' — Height of the divider0 (default) | scalar integer

Specify as a scalar integer the height of the divider in the display in units of 16 pixels. When you choose 0, the value of the DisplayChannelHeight property in the Logic Analyzer is used.

Example: 'Height',2

Data Types: double

'Name' — The name or label for the divider'' (default) | string

Specify as a string the name that you would like to set for the new divider.

Example: 'Name','MyDivider'

Data Types: char

Was this topic helpful?