Main Content

Share Data Within App Designer Apps

Using properties is the best way to share data within an app because properties are accessible to all functions and callbacks in an app. All UI components are properties, so you can use this syntax to access and update UI components within your callbacks:

app.Component.Property

For example, these commands get and set the Value property of a gauge. In this case, the name of the gauge is PressureGauge.

x = app.PressureGauge.Value; % Get the gauge value
app.PressureGauge.Value = 50; % Set the gauge value to 50

However, if you want to share an intermediate result, or data that multiple callbacks need to access, then define a public or private property to store your data. Public properties are accessible both inside and outside of the app, whereas private properties are only accessible inside of the app. Code View provides a few different ways to create a property:

  • Expand the drop-down menu from the bottom half of the Property button in the Editor tab. Select Private Property or Public Property.

    Property button options.

  • Click on the Properties tab in the Code Browser, expand the drop-down list on the Plus button, and select Private Property or Public Property.

    Properties tab in the Code Browser. The tab contains a search bar to find properties, and a plus button to add a new property.

After you select an option to create a property, App Designer adds a property definition and a comment to a properties block.

properties (Access = public)
        Property % Description
end

The properties block is editable, so you can change the name of the property and edit the comment to describe the property. For example, this property stores a value for average cost:

properties (Access = public)
        X % Average cost
end

If your code needs to access a property value when the app starts, you can initialize its value in the properties block or in the startupFcn callback.

properties (Access = public)
        X = 5; % Average cost
end

Elsewhere in your code, use dot notation to get or set the value of a property:

y = app.X  % Get the value of X
app.X = 5; % Set the value of X

Example: Share Plot Data and a Drop-Down List Selection

Open App

This app shows how to share data in a private property and a drop-down list. It has a private property called Z that stores plot data. The callback function for the edit field updates Z when the user changes the sample size. The callback function for the Update Plot button gets the value of Z and the colormap selection to update the plot.

Related Topics