Simulink.sdi.setSubPlotLayout

R2026b

Set subplot layout in Simulation Data Inspector

Syntax

Simulink.sdi.setSubPlotLayout(r,c)

Simulink.sdi.setSubPlotLayout(r,c,TabIndex=idx)

Description

Simulink.sdi.setSubPlotLayout(r,c) sets the grid layout of subplots on the active tab in the Simulation Data Inspector using the specified number of rows r and columns c.

Simulink.sdi.setSubPlotLayout(r,c,TabIndex=idx) sets the subplot layout for the tab specified by idx.

Examples

Change Subplot Layout

Change the subplot layout to 4 rows and 2 columns.

Simulink.sdi.setSubPlotLayout(4,2);

Create Run and View Data

Create a run, add data to it, and then view the data in the active tab of the Simulation Data Inspector.

Create Data for Run

Create two timeseries objects to contain data for a sine signal and a cosine signal. Give each timeseries object a descriptive name.

time = linspace(0,20,101);

sine_vals = sin(2*pi/5*time);
sine_ts = timeseries(sine_vals,time);
sine_ts.Name = "Sine, T=5";

cos_vals = cos(2*pi/8*time);
cos_ts = timeseries(cos_vals,time);
cos_ts.Name = "Cosine, T=8";

Create Run and Add Data

To open the Simulation Data Inspector, use Simulink.sdi.view.

Simulink.sdi.view

To import data into the Simulation Data Inspector from the workspace, create a Simulink.sdi.Run object using Simulink.sdi.Run.create. Add metadata information using the Name and Description properties of the Run object.

sinusoidsRun = Simulink.sdi.Run.create;
sinusoidsRun.Name = "Sinusoids";
sinusoidsRun.Description = "Sine and cosine signals with different frequencies";

Add the data you created in the workspace to the empty run.

add(sinusoidsRun,"vars",sine_ts,cos_ts);

 0.091530s wall, 0.156250s user + 0.031250s system = 0.187500s CPU (204.9%)

Plot Data in Simulation Data Inspector

To access the Simulink.sdi.Signal object corresponding to each signal, use getSignalByIndex. You can use the Simulink.sdi.Signal object properties to specify the line style and color for the signal and plot the signal in the Simulation Data Inspector. For example, specify the LineColor and LineDashed properties for each signal.

sine_sig = getSignalByIndex(sinusoidsRun,1);
sine_sig.LineColor = [0 0 1];
sine_sig.LineDashed = "-.";

cos_sig = sinusoidsRun.getSignalByIndex(2);
cos_sig.LineColor = [1 0 0];
cos_sig.LineDashed = "--";

To configure a 2-by-1 subplot layout in the active tab of the Simulation Data Inspector plotting area, use Simulink.sdi.setSubPlotLayout. To plot the sine signal on the upper subplot and the cosine signal on the lower subplot, use plotOnSubPlot.

Simulink.sdi.setSubPlotLayout(2,1);

plotOnSubPlot(sine_sig,1,1,true);
plotOnSubPlot(cos_sig,2,1,true);

Inspect Data Using Cursors

To access the value of a signal at a specific time, you can add a cursor to the plot. For example, the Sine signal appears to have a local maximum at about 6 seconds. Add one cursor to the plot and observe the signal value at 6 seconds.

Simulink.sdi.setNumCursors(1)
Simulink.sdi.setCursorPositions("left",6)

To measure the time difference between two points or extract descriptive statistics within the defined interval, add two cursors.

Simulink.sdi.setNumCursors(2)
Simulink.sdi.setCursorPositions("left",5,"right",7)

Determine the local maximum sample value in the Sine signal between the cursors using the max function.

[t1,t2] = Simulink.sdi.getCursorPositions;
localMax = max(sine_sig,t1,t2)

localMax = 
0.9980

Close Simulation Data Inspector and Save Data

When you finish inspecting the plotted signal data, you can close the Simulation Data Inspector and save the session to an MLDATX file.

Simulink.sdi.close("sinusoids.mldatx")

Set Subplot Layout on Specific Tab

To set the subplot layout for a specific tab, specify the tab index using the TabIndex name-value argument. For example, set a 2-by-3 subplot layout on the second tab in the Simulation Data Inspector.

Simulink.sdi.setSubPlotLayout(2,3,TabIndex=2)

Input Arguments

r — Number of rows

positive integer

Number of rows in the subplot grid layout, specified as a positive integer between 1 and 8, inclusive.

Example: 2

c — Number of columns

positive integer

Number of columns in the subplot grid layout, specified as a positive integer between 1 and 8, inclusive.

Example: 2

idx — Tab index

positive integer

Since R2026b

Tab index, specified as a positive integer between 1 and 8, inclusive. Tabs are indexed from 1 to 8, left to right in the Simulation Data Inspector. Reordering tabs in the Simulation Data Inspector updates the indices.

You can also locate a tab programmatically using the TabsList property of the Simulink.sdi.TabGroup object. For example, the tab named Tab2 is at index 2.

tabGrp = Simulink.sdi.TabGroup;
allTabs = tabGrp.TabsList;
fprintf("%-10s %-10s %-10s %-10s\n", "Name","Color","Index","IsActive");
for k = 1:numel(allTabs)
    fprintf("%-10s %-10s %-10d %-10d\n",allTabs(k).Name, ...
        allTabs(k).Color,allTabs(k).Index,allTabs(k).IsActive);
end

Name       Color      Index      IsActive  
Tab1       none       1          0         
Tab2       none       2          0         
Tab3       none       3          1    

When you do not specify TabIndex, the function operates on the active tab.

Example: TabIndex=2

Limitations

• You cannot set a three-plot layout or apply overlays programmatically. Instead, in the Simulation Data Inspector, select Visualizations and layouts . Then, choose your three-plot or overlay layout.

Version History

Introduced in R2016a

R2026b: Specify tab on which to set subplot layout

To set the subplot layout on a specific tab in the Simulation Data Inspector, use the TabIndex name-value argument.