Documentation Center

  • Trial Software
  • Product Updates

addCursor

System object: dsp.LogicAnalyzer
Package: dsp

Add cursor to display

Syntax

cursorTag = addCursor(H)
cursorTag = addCursor(H,'Name',Value)

Description

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

cursorTag = addCursor(H,'Name',Value) adds in a cursor 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 cursordsp.LogicAnalyzer object

Example: 'addCursor(H)' adds a cursor with the default characteristics.

Example: 'H.addCursor()' adds a cursor 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: 'Location',2,'Color','Blue' specifies that a cursor should be moved to the 2-second mark and colored blue.

'Color' — Color of the cursorstring enumeration

Specify as a string the color of the cursor from one of the following options:

  • 'Black'

  • 'Blue'

  • 'Cyan'

  • 'Green'

  • 'Magenta'

  • 'Red'

  • 'White'

  • 'Yellow'

Example: 'Color','Blue'

Data Types: char

'Location' — Location of the cursornumeric scalar

Specify as a numeric scalar value, in seconds, the cursor location.

Example: 'Location','1.0'

Data Types: double

'Locked' — Locked status of the cursorlogical scalar

Specify as a logical scalar whether the cursor location should be locked.

  • If you choose true, then the cursor's location cannot be changed. Logic Analyzer denotes this by assigning a default color of red.

  • If you choose false, then the cursor's location can be changed. Logic Analyzer denotes this by assigning a default color of yellow.

Example: 'Locked',true

Data Types: logical

Was this topic helpful?