Simulink.sdi.setNumCursors

R2026b

Configure number of cursors active in Simulation Data Inspector

collapse all in page

    Syntax

    Simulink.sdi.setNumCursors(num)
    Simulink.sdi.setNumCursors(num,view)

    Description

    Simulink.sdi.setNumCursors(num) sets the number of cursors to display on plots in the Inspect pane across all Simulation Data Inspector tabs to the value specified by num.

    Simulink.sdi.setNumCursors(num,view) configures the number of cursors to display in the Inspect or Compare plot area, as specified by view.

    example

    Examples

    collapse all

    You can use the Simulation Data Inspector programmatic interface to specify the position of cursors on time plots or sparklines and to access the time that corresponds to the current cursor position.

    Suppose you want to know the signal values 5 seconds into the simulation. Use the Simulink.sdi.setCursorPositions function to move the cursor to 5 on the time axis and read the signal values from the cursor on each subplot. The asterisk next to the value in the cursor label indicates that the value is interpolated because the simulation did not include a calculation for a simulation time of exactly 5 seconds.

    Simulink.sdi.setCursorPositions(Left=5);

    Subplots of x1 on the top and x2 on the bottom showing the data cursor at 5 seconds.

    Suppose you want to calculate the time between two peaks in the x2 signal. Add a second cursor using the Simulink.sdi.setNumCursors function or by using Show/hide data cursors in the Simulation Data Inspector. 

    Simulink.sdi.setNumCursors(2);

    Drag the cursors so the left cursor is positioned at the first peak in the x2 signal and the right cursor is positioned at the second peak. Alternatively, you can run this code that positions the cursors for you.

    Simulink.sdi.setCursorPositions(Left=5.921998549931304,...
    Right=12.378442136906246);

    Subplots of x1 on the top and x2 on the bottom with two cursors.

    The Simulation Data Inspector displays the difference between the two cursors in seconds. However, the cursor position and difference values are both rounded. Use the Simulink.sdi.getCursorPositions function to programmatically retrieve the exact time values that correspond to the cursor positions. Then, compute the difference between the times.

    [t1,t2] = Simulink.sdi.getCursorPositions;
T = t2 - t1
    T = 6.4564

    Input Arguments

    collapse all

    Number of cursors to display, specified as 0, 1, or 2.

    Plot area in which to display cursors, specified as 'inspect' or 'compare'.

    Data Types: char | string

    Version History

    Introduced in R2021a

    See Also

    Functions

    Topics