uisimprogress

R2026b

Display simulation progress bar in app

Since R2024a

collapse all in page

    Syntax

    simprog = uisimprogress
    simprog = uisimprogress(p)
    simprog = uisimprogress(___,Name=Value)

    Description

    simprog = uisimprogress creates a simulation progress bar in a new figure and returns the SimulationProgress object. MATLAB® calls the uifigure function to create the figure.

    simprog = uisimprogress(p) creates a simulation progress bar in the specified parent container. The parent can be a Figure object or one of its child containers.

    simprog = uisimprogress(___,Name=Value) creates a simulation progress bar with properties specified by one or more name-value arguments.

    example

    Examples

    collapse all

    Add a simulation progress component to an app. Then, connect the component to a Simulation object.

    Create a simulation progress bar inside a panel in a UI figure.

    f = uifigure(Name="MyFigure");
panel = uipanel(f);
progressBar = uisimprogress(panel);

    To connect the progress bar to a simulation, specify the Simulation property. When the simulation runs, the progress bar displays simulation progress.

    mdl = "MyModel";
sm = simulation(mdl);
progressBar.Simulation = sm;

    Input Arguments

    collapse all

    Parent container, specified as a Figure object created using the uifigure function or one of its child containers, such as a Tab, Panel, or GridLayout object. If you do not specify a parent container, MATLAB calls the uifigure function to create a new Figure object that serves as the parent container.

    Name-Value Arguments

    collapse all

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: uisimprogress(Color="green")

    Note

    This section lists a subset of the available properties. For the full list, see SimulationProgress Properties.

    Color of the simulation progress bar, specified as an RGB triplet, a hexadecimal color code, or one of the color options listed in the table.

    RGB triplets and hexadecimal color codes are useful for specifying custom colors.

    • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

    • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes "#FF8800", "#ff8800", "#F80", and "#f80" are equivalent.

    Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

    Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
    "red""r"[1 0 0]"#FF0000"

    Sample of the color red

    "green""g"[0 1 0]"#00FF00"

    Sample of the color green

    "blue""b"[0 0 1]"#0000FF"

    Sample of the color blue

    "cyan" "c"[0 1 1]"#00FFFF"

    Sample of the color cyan

    "magenta""m"[1 0 1]"#FF00FF"

    Sample of the color magenta

    "yellow""y"[1 1 0]"#FFFF00"

    Sample of the color yellow

    "black""k"[0 0 0]"#000000"

    Sample of the color black

    "white""w"[1 1 1]"#FFFFFF"

    Sample of the color white

    The table summarizes RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

    RGB TripletHexadecimal Color CodeAppearance
    [0 0.4470 0.7410]"#0072BD"

    Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

    [0.8500 0.3250 0.0980]"#D95319"

    Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

    [0.9290 0.6940 0.1250]"#EDB120"

    Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

    [0.4940 0.1840 0.5560]"#7E2F8E"

    Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

    [0.4660 0.6740 0.1880]"#77AC30"

    Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

    [0.3010 0.7450 0.9330]"#4DBEEE"

    Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

    [0.6350 0.0780 0.1840]"#A2142F"

    Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

    Data Types: double | string | char

    Option to display simulation time, specified as "on" or "off".

    Option to display the elapsed simulation time, specified as "on" or "off".

    Simulation to monitor, specified as a Simulation object.

    Version History

    Introduced in R2024a

    See Also

    Properties

    Objects

    Functions