2.matlab Env
2.matlab Env
R2024b
How to Contact MathWorks
Phone: 508-647-7000
v
Startup Options in MATLAB Startup File . . . . . . . . . . . . . . . . . . . . . . . . . 1-20
Passing Perl Variables on Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20
Startup and Calling Java Software from MATLAB . . . . . . . . . . . . . . . . . . 1-21
Desktop
2
Zoom and Change Desktop Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Change Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Change Font Name and Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Advanced Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Add Additional Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
vi Contents
Use Keyboard Shortcuts to Navigate MATLAB . . . . . . . . . . . . . . . . . . . . . 2-30
Installed MATLAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30
MATLAB Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
Navigate Figures in MATLAB Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32
Additional Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33
vii
Entering Commands
3
Enter Statements in Command Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
viii Contents
Translated Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Change Documentation Language in your System Web Browser . . . . . . . 4-10
Change Documentation Language for Installed Documentation . . . . . . . . 4-10
ix
Compare and Merge Live Scripts and Functions . . . . . . . . . . . . . . . . . . . 6-17
Select Files to Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Explore Differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Merge Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
x Contents
Change Folders on Search Path Using MATLAB Editor . . . . . . . . . . . . . . 6-53
Resolve Issue: MATLAB Did Not Appear to Successfully Set the Search
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
Possible Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
Editor Preferences
7
Editor/Debugger Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
General Preferences for the Editor/Debugger . . . . . . . . . . . . . . . . . . . . . . 7-2
Editor/Debugger Display Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Editor/Debugger Tab Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Editor/Debugger Language Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Editor/Debugger Code Folding Preferences . . . . . . . . . . . . . . . . . . . . . . . 7-8
Editor/Debugger Backup Files Preferences . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Editor/Debugger Autoformatting Preferences . . . . . . . . . . . . . . . . . . . . . 7-10
Editor/Debugger Automatic Completions Preferences . . . . . . . . . . . . . . . 7-11
Editor/Debugger Find and Replace Preferences . . . . . . . . . . . . . . . . . . . 7-14
Editor/Debugger Indenting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Editor/Debugger Saving Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
xi
Modify Existing Code Analyzer Checks . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
Add-Ons
8
Get and Manage Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Get Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Install Add-Ons from File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Default Add-On Installation Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Manage Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Update Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Run Apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Get and Manage Add-Ons Using the Add-Ons Panel in MATLAB Online . . . 8-4
Internationalization
9
Set Locale and Display Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Unsupported Locale Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Supported Character Sets and Encodings . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
xii Contents
Localized Formats in Current Folder Browser . . . . . . . . . . . . . . . . . . . . . . 9-3
Numbers Display Period for Decimal Point for All Locales . . . . . . . . . . . . 9-7
MATLAB Online
10
Access Files in MATLAB Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Upload and Download Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Preview Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Cloud Storage
11
Use MATLAB Online to Access Files in Microsoft OneDrive . . . . . . . . . . 11-2
Connect to OneDrive Account and Access Files . . . . . . . . . . . . . . . . . . . . 11-2
Disconnect OneDrive Account from MATLAB Online . . . . . . . . . . . . . . . . 11-3
Granting MATLAB Permission to Your OneDrive Account . . . . . . . . . . . . 11-4
MATLAB Drive
12
Install MATLAB Connector for MATLAB Drive . . . . . . . . . . . . . . . . . . . . . 12-2
Install Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
Uninstall Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
xiii
Use MATLAB Connector to Manage Your Files . . . . . . . . . . . . . . . . . . . . . 12-4
Start MATLAB Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
Open MATLAB Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
View Status and Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
View Recent File Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
Manage File Conflicts and Sync Issues . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
Manage File Syncing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
Stop MATLAB Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
Post-Installation Tasks
13
Configure the MATLAB Startup Accelerator . . . . . . . . . . . . . . . . . . . . . . . 13-2
Change When the MATLAB Startup Accelerator Runs . . . . . . . . . . . . . . . 13-2
xiv Contents
Return to Original Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
xv
1
When you start MATLAB, it automatically adds the userpath folder to the search path. MATLAB also
reopens any desktop components that were open when you last shut down.
The MATLAB startup folder is the folder you are in when you get the MATLAB prompt. To change the
default startup folder, see “MATLAB Startup Folder” on page 1-15.
If you have trouble starting MATLAB, then see “Installation and Licensing”.
You also can specify a custom startup folder in the MATLAB shortcut icon using the Start in field.
However, this technique is the same as setting a custom path in the Initial working folder
preference. If you enter an invalid path in the Start in field, then the startup folder is unpredictable.
To set a custom path in the Start in field:
1 Right-click the shortcut icon for MATLAB
and select
Properties from the context menu. The Properties dialog box for MATLAB opens to the
Shortcut pane.
2 In the Start in field, type the full path to a folder on your system, and then click OK.
The startup folder is the folder in which you run the matlab command. To use the folder specified by
the Initial working folder preference, type:
matlab -useStartupFolderPref
1-2
Start MATLAB on Windows Platforms
!matlab
For example, using the Windows Explorer tool, double-click a file with a .m extension. MATLAB starts
and opens the file in the MATLAB Editor.
See Also
matlab (Windows) | userpath | Preferences
More About
• “Specify Startup Options” on page 1-19
• “MATLAB Startup Folder” on page 1-15
• “Installation and Licensing”
1-3
1 Startup and Shutdown
By default, MATLAB associates the latest installed version to MATLAB file types. However, once you
use the Windows Control Panel or the file manager to associate a MATLAB version to a file type, you
must manually re-associate the type with each new installation of MATLAB. If you want to return to
the default behavior, then uninstall every MATLAB that is manually associated to any MATLAB file
type. Then reinstall the latest MATLAB release.
1-4
Start MATLAB on Linux Platforms
To start MATLAB at the operating system prompt on Linux platforms, call matlab from the bin
folder in which you installed MATLAB. For example, if you installed MATLAB R2024b in the default
installation folder, then type:
/usr/local/MATLAB/R2024b/bin/matlab
If you set up symbolic links during the installation procedure, then type matlab from the folder you
specified.
After starting MATLAB, the desktop opens. Desktop components that were open when you last shut
down MATLAB reopen. If the DISPLAY environment variable is not set or is invalid, then the desktop
does not display.
The MATLAB startup folder is the folder you are in when you get the MATLAB prompt. To change the
default startup folder, see “MATLAB Startup Folder” on page 1-15.
If you have trouble starting MATLAB, then see “Installation and Licensing”.
Startup Folder
On Linux platforms, the default startup folder is the folder from which you started MATLAB.
To specify the userpath as the startup folder, set the value of the environment variable
MATLAB_USE_USERWORK to 1 before startup. By default, userpath is userhome/Documents/
MATLAB. To specify a different folder for userpath, and for other options, call the MATLAB
userpath function.
The ssh command pipes hello.m to MATLAB running on the remote host local.foo.com. The -
nodisplay option starts MATLAB without the desktop.
See Also
matlab (Linux) | userpath | matlabroot | Preferences
More About
• “Specify Startup Options” on page 1-19
• “MATLAB Startup Folder” on page 1-15
1-5
1 Startup and Shutdown
1-6
Start MATLAB on macOS Platforms
When you start MATLAB, it automatically adds the userpath folder to the search path. MATLAB also
reopens any desktop components that were open when you last shut down.
The MATLAB startup folder is the folder you are in when you get the MATLAB prompt. To change the
default startup folder, see “MATLAB Startup Folder” on page 1-15.
If MATLAB fails to start due to a problem with required system components such as Java® software,
then diagnostics run automatically. The software advises you of the problem and offers suggestions to
correct it. For information about other startup problems, see “Installation and Licensing”.
The startup folder is the last working folder from the previous MATLAB session or the custom path
specified in the Initial working folder preference. The Initial working folder preference is located
in the General Preferences page of the Preferences window.
matlabroot/bin
• Start MATLAB.
./matlab
1-7
1 Startup and Shutdown
See Also
matlab (macOS) | userpath | matlabroot | Preferences
More About
• “Specify Startup Options” on page 1-19
• “MATLAB Startup Folder” on page 1-15
• “Installation and Licensing”
1-8
Exit MATLAB
Exit MATLAB
In this section...
“Ways to Quit or Exit” on page 1-9
“Confirm Exiting” on page 1-9
“Run Script When Exiting” on page 1-10
Confirm Exiting
To set a preference that displays a confirmation dialog box when you exit:
MATLAB then displays the following dialog box when you exit.
You can also display your own exit confirmation dialog box using a finish.m script, as described in
the following section.
1-9
1 Startup and Shutdown
There are two sample files in matlabroot/toolbox/local that you can use as the basis for your
own finish.m file:
See Also
exit | quit | finish | Preferences
More About
• “Recovering Data After Abnormal Termination” on page 1-11
• “Crash Reporting” on page 1-12
• “Installation and Licensing”
1-10
Recovering Data After Abnormal Termination
• Use the Command History or the file on which it is based, history.m, to run statements from the
previous session. You might be able to recreate data as it was before the termination.
• If you used the diary function or -logfile startup option for the session in which MATLAB
terminated unexpectedly, then you might be able to recover output.
• If you saved the workspace to a MAT-file during the session, then you can recover it by loading the
MAT-file.
• If you were editing a file in the Editor when MATLAB terminated unexpectedly, and you had the
backup feature enabled, then you should be able to recover changes you made to files you had not
saved. To recover, open the backup version filename.asv in the Editor. Then save it as
filename.m to use the last good version of filename.
• If you were in a Simulink® session when a segmentation violation occurred, and you have the
Simulink Autosave Options preference selected, then the last autosave file for the model reflects
the state of the autosave data before the segmentation violation. Because Simulink models might
be corrupted by a segmentation violation, a model is not autosaved after a segmentation violation
occurs. To recover the file, open the model.
See Also
diary | save | load
Related Examples
• “Save and Load Workspace Variables” on page 5-12
• “Save and Back Up Code”
More About
• “Commonly Used Startup Options” on page 1-18
1-11
1 Startup and Shutdown
Crash Reporting
If MATLAB crashes, then the MathWorks Crash Reporter dialog box prompts you to send the crash
report to MathWorks. Doing so helps us improve our products. The crash report contains one or more
crash logs containing information on the stack trace and the MATLAB configuration. You can see the
entire contents of the crash report by clicking the Show Report button in the dialog box. This data,
along with information that you provide as reproduction steps, is the only information sent to
MathWorks.
Reproduction steps are most helpful if you know what appears to cause the crash, but any
information on what you were doing at the time helps our developers better understand the cause.
• If you do know the cause of the crash, then look for information about it in the MathWorks Bug
Reports database.
• If the problem is reproducible, then submit a support case at https://www.mathworks.com/support/
contact_us.html.
• On Windows platforms:
dir(fullfile(tempdir,'prefix*'))
dir(fullfile('~','prefix*'))
See Also
tempdir
More About
• “When MATLAB Terminates Unexpectedly” on page 1-13
1-12
When MATLAB Terminates Unexpectedly
If you do not receive an email, then you can directly contact Technical Support at https://
www.mathworks.com/support/contact_us.html.
After viewing the solution, if you feel that it is not relevant, then click Send Report and enter
reproduction steps in the window.
If you apply the fix and still experience a crash, then click Send Report or create a support case
directly at https://www.mathworks.com/support/contact_us.html.
See Also
More About
• “Crash Reporting” on page 1-12
1-13
1 Startup and Shutdown
• MATLAB startup folder, if starting MATLAB from an operating system prompt. For more
information, see “MATLAB Startup Folder” on page 1-15.
• If there is no java.opts file in the startup folder, then MATLAB checks the matlabroot/bin/
arch folder. matlabroot is the output of the matlabroot function. arch is the output of the
MATLAB computer('arch') function, for example glnxa64.
A java.opts file in this location applies to all users, but individual users might not have
permissions to modify files there.
• To enable the use of the Java debugger, use the matlab -jdb command. For information, see
matlab (Linux) or matlab (macOS).
• To adjust the Java heap size on desktop versions of MATLAB, use “Java Heap Memory
Preferences”.
• To modify the static Java class path, create a javaclasspath.txt file. For information, see
“Static Path of Java Class Path”.
To modify the library path, create a javalibrarypath.txt file. For information, see “Locate
Native Method Libraries”.
• To override built-in options that MATLAB specifies to Java at startup. Options in java.opts are
appended to the end of the built-in list. Whether these additional options override built-in options
is JVM-dependent and can change between Java versions. To see what options MATLAB provides
to Java, run this command:
java.lang.management.ManagementFactory.getRuntimeMXBean.getInputArguments
See Also
matlab (Linux) | matlab (macOS)
Related Examples
• “Java Heap Memory Preferences”
• “Static Path of Java Class Path”
• “Locate Native Method Libraries”
More About
• “MATLAB Startup Folder” on page 1-15
1-14
MATLAB Startup Folder
Note If a startup.m file changes the current folder, then this value overrides the initial working
folder value. Do not add cd statements to startup.m. For more information about user-defined
options, see startup.
For more information, see “Start MATLAB on Windows Platforms” on page 1-2.
If you start MATLAB by double-clicking the MATLAB shortcut icon and the startup folder is set to an
unexpected location, follow these steps to ensure that the Start in field in the MATLAB shortcut icon
is empty:
1-15
1 Startup and Shutdown
For more information, see “Start MATLAB on macOS Platforms” on page 1-7.
On Linux platforms, the default startup folder is the folder from which you started MATLAB.
For more information, see “Start MATLAB on Linux Platforms” on page 1-5.
Alternatively on Windows platforms, specify the initial working folder in the MATLAB shortcut icon.
For more information, see “Select MATLAB Icon” on page 1-2.
• You can store the MATLAB files you work with in one folder, such as Documents/MATLAB.
• You can always run your files because MATLAB automatically adds the userpath folder to the top
of the search path.
• The first time you run a new version of MATLAB, the software automatically creates the
userpath folder if it does not exist.
• When you upgrade to a newer version of MATLAB, the software automatically continues to use the
same startup folder and your existing files.
• The default userpath uses the benefits provided by the standard location in the Windows and
macOS environments for storing personal files. Files in the Documents/MATLAB folder are
available to you when you use other machines. Each user has an individual Documents/MATLAB
folder. Other users, even those using your machine, cannot access files in your Documents/
MATLAB folder.
See Also
startup | Preferences
1-16
MATLAB Startup Folder
Related Examples
• “Start MATLAB on Windows Platforms” on page 1-2
• “Start MATLAB on macOS Platforms” on page 1-7
• “Start MATLAB on Linux Platforms” on page 1-5
1-17
1 Startup and Shutdown
For example, you cannot set preferences if you start MATLAB with the
-nojvm option. However, you can start MATLAB once without the -
nojvm option, set the preference, and quit MATLAB. MATLAB
remembers that preference when you start it again, even if you use the
-nojvm option.
All -nosplash Start MATLAB without displaying its splash screen.
All -batch "statement" Run the specified statement non-interactively.
All -r "statement" Run the specified statement interactively.
All -singleCompThread Limit MATLAB to a single computational thread. This option is for
numerical computations only.
For a complete list of options, refer to the input arguments for matlab (Windows), matlab
(macOS), or matlab (Linux).
See Also
matlab (Windows) | matlab (macOS) | matlab (Linux)
1-18
Specify Startup Options
In this section...
“Startup Options from Operating System Prompt” on page 1-19
“Startup Options in Shortcut on Windows Systems” on page 1-19
“Startup Options in MATLAB Startup File” on page 1-20
“Passing Perl Variables on Startup” on page 1-20
“Startup and Calling Java Software from MATLAB” on page 1-21
matlab -nosplash
On Windows platforms, you can precede a startup option with either a hyphen (-) or a slash (/). For
example, -nosplash and /nosplash are equivalent.
To use startup options for the MATLAB shortcut icon, follow these steps:
This example runs the MATLAB results script or function after startup, where results.m is in the
startup folder or on the MATLAB search path. The text in the Target field is similar to the following:
Include the statement, but not the option (-r) in double quotation marks.
Use semicolons or commas to separate multiple statements. This example changes the format to
short, and then runs the MATLAB code file results:
Separate multiple options with spaces. This example starts MATLAB without displaying the splash
screen, and then runs the MATLAB code file results:
1-19
1 Startup and Shutdown
The startup.m file is a file you create to specify startup options. Create the startup.m file in a
folder on the MATLAB search path. Use startup.m to modify the default search path, predefine
variables in your workspace, or define defaults for graphics objects. For example, the following
statement adds the user-defined folder /home/myname/mytools to the search path.
addpath /home/myname/mytools
To change the current folder on startup to mytools, set the Initial working folder value, located in
the General Preferences options in the Preferences window:
/home/myname/mytools
At startup, MATLAB automatically executes the matlabrc.m file and startup.m, if it exists on the
MATLAB search path. The file matlabrc.m, which is in the matlabroot/toolbox/local folder, is
reserved for use by MathWorks and by system administrators on multiuser systems. To locate the
startup.m file, type:
which startup
If MATLAB finds a startup.m file, then it displays the path to the file.
Note
MATLAB executes any file on the search path named startup that has an executable file extension.
Examples of an executable file extension are .m, .mlx, and .mlapp.
function test(x)
To pass a Perl variable instead of a constant as the input parameter, follow these steps. This command
starts MATLAB and runs test with the input argument 10.
#!/usr/local/bin/perl
$val = 10;
system('matlab -r "test(' . ${val} . ')"');
2 Invoke the Perl script at the prompt using a Perl interpreter.
For more information, see the -r option in matlab (Windows), matlab (macOS), or matlab
(Linux).
1-20
Specify Startup Options
For information about memory allocation for Java objects, see “Java Heap Memory Preferences”.
See Also
matlab (Windows) | matlab (macOS) | matlab (Linux) | Preferences
More About
• “Commonly Used Startup Options” on page 1-18
• “What Is the MATLAB Search Path?” on page 6-47
1-21
1 Startup and Shutdown
In this section...
“About Toolbox Path Caching in MATLAB” on page 1-22
“Using the Cache File Upon Startup” on page 1-22
“Updating the Cache and Cache File” on page 1-22
MATLAB does not use the cache file at startup if you clear the Enable toolbox path cache check
box in General Preferences page of the Preferences Window. Instead, it creates the cache by
reading from the operating system folders, which is slower than using the cache file.
MATLAB caches (essentially, stores in a known files list) the names and locations of files in the
matlabroot folder. This folder is for files provided with MathWorks products that should not change
except for product installations and updates. Caching those folders provides better performance
during a session because MATLAB does not actively monitor those folders.
We strongly recommend that you save any MATLAB code files you create and any files provided by
MathWorks that you edit in a folder that is not in the matlabroot folder tree. If you keep your files
in the matlabroot folder, then they might be overwritten when you install a new version of MATLAB.
When you add files to the matlabroot folder, the cache and the cache file need to be updated.
MATLAB updates the cache and cache file automatically when you install toolboxes or toolbox
updates using the installer for MATLAB. MATLAB also updates the cache and cache file automatically
when you use MATLAB tools, such as when you save files from the MATLAB Editor to the
matlabroot folder.
When you add or remove files in the matlabroot folder by some other means, MATLAB might not
recognize those changes. For example, when you:
1-22
Toolbox Path Caching in MATLAB
and then attempt to use one of the new files, MATLAB displays this message:
Update the cache so MATLAB recognizes the changes you made in the matlabroot folder.
1 On the Home tab, in the Environment section, click Preferences. Select MATLAB >
General.
2 Click Update Toolbox Path Cache and click OK.
Function Alternative
To update the cache, use rehash toolbox. To update both the cache and the cache file, use rehash
toolboxcache. For more information, see rehash.
1-23
1 Startup and Shutdown
To suppress these messages, open a terminal with root privileges and execute the relevant commands
to install the libcanberra Linux package.
• sh or bash commands:
$ export GTK_PATH=/usr/lib64/gtk-2.0
• csh/tcsh commands:
Debian-Based Distributions
On Debian®-based distributions (including Ubuntu®):
• sh or bash commands:
$ export GTK_PATH=/usr/lib/x86_64-linux-gnu/gtk-2.0
• csh/tcsh commands:
1-24
2
Desktop
You can change the zoom level, font size, name, and style used by tools in MATLAB. You also can
install new fonts to use with MATLAB.
Zoom
You can change the zoom level in the Editor and Live Editor. To change the zoom level, go to the View
tab and select Zoom In, Zoom Out, or Reset Zoom.
Alternatively, you can change the zoom level using the keyboard shortcuts described in this table.
In MATLAB Online™, to change the zoom level, adjust the zoom settings for your web browser.
Tool Procedure
Live Editor Specify the code and text font size for the current document using
the Customize Styles dialog box.
Go to the Live Editor tab, and in the Text section, click the
Customize styles button .
To specify the code and text font size for all open documents and
all new documents, use the matlab.fonts Settings. For example,
this code changes the code font size in the Live Editor.
s = settings;
s.matlab.fonts.editor.code.Size.TemporaryValue = '26pt'
2-2
Zoom and Change Desktop Fonts
Tool Procedure
Code tools Specify the font size using font preferences.
• Current Folder browser On the Home tab, in the Environment section, click
• Workspace browser Preferences. Select MATLAB > Fonts and in the Desktop text
• Variables editor font section, clear the Use system font check box. Then, select a
font size.
Tool Procedure
Live Editor Specify the code and text font name and font style for the current
document using the Customize Styles dialog box.
Go to the Live Editor tab, and in the Text section, click the
Customize styles button .
To specify the code and text font name and font style for all open
documents and all new documents, use the matlab.fonts Settings.
For example, this code changes the font name and style of normal
text in the Live Editor.
s = settings;
s.matlab.fonts.editor.normal.Name.PersonalValue = 'Calibri';
s.matlab.fonts.editor.normal.Style.PersonalValue = {'bold'};
2-3
2 Desktop
Tool Procedure
Code tools Specify the font name and style using font preferences.
• Current Folder browser On the Home tab, in the Environment section, click
• Workspace browser Preferences. Select MATLAB > Fonts and, in the Desktop text
• Variables editor font section, clear the Use system font check box. Then, select a
font name and style. By default, the text font is set to your system
font.
In MATLAB Online, changing the font name and style for text-
based tools is not supported.
MATLAB web browser Changing the font name and style is not supported.
To apply antialiasing and create a smoother desktop appearance on Linux systems, select Use
antialiasing to smooth desktop fonts. You must restart MATLAB for the preference to take effect.
On Microsoft Windows and macOS platforms, MATLAB uses system setting for antialiasing.
Advanced Customization
You can further customize fonts in MATLAB by changing the font preferences for an individual tool.
To change the font preferences for an individual tool, on the Home tab, in the Environment section,
click Preferences. Select MATLAB > Fonts > Custom and choose a tool from the list of
Desktop tools. Then, select the font to use:
• Desktop code — Select this option to use the desktop code font for this tool.
• Desktop text — Select this option to use the desktop text font for this tool.
• Custom — Select this option to specify a custom font for this tool. Then, specify a font name,
style, and size. Some options are not supported for all tools.
For example, to change the Editor font to a custom font, in the list of Desktop tools, select Editor.
Then, in the Font to use section, select Custom and specify the desired font name, style, and size. In
MATLAB Online, these preferences are located under MATLAB > Appearance > Fonts > Custom.
To customize code and text fonts in the Live Editor, use the Customize Styles dialog box or the
matlab.fonts. For more information, see “Format Text in the Live Editor”.
2-4
Zoom and Change Desktop Fonts
This table shows the default font preferences for the tools in MATLAB. You can use this table to
restore fonts to their original state.
1 Choose a font. The font must be compatible with MATLAB. MATLAB only includes compatible
fonts in the font preferences.
• For desktop components (such as the Command Window), figure windows, and uicontrols,
fonts must be compatible with TrueType and Microsoft OpenType® fonts
• For graphics objects, such as xlabel, ylabel, title, and text, fonts must be TrueType
and Microsoft OpenType fonts
2 Install the font. For details on installing fonts on your system, refer to the documentation for your
system.
Install the font in the /jre/lib/fonts folder where Java software is installed on your system,
for example, C:\Program Files\MATLAB\R2024a\sys\java\jre\win64\jre\lib\fonts.
3 Restart MATLAB.
4 Use the font in MATLAB by following the instructions in “Change Font Name and Style” on page
2-3.
2-5
2 Desktop
In MATLAB Online, to add an additional font, install the font on your system. Then, go to the
MATLAB > Appearance > Fonts > Custom preferences, select Custom in the Font to use
sections and manually enter the new font name in the drop-down list.
See Also
Preferences
Related Examples
• “Add Title and Axis Labels to Chart”
• “Change Desktop Colors” on page 2-7
• “Set Print Options for Command Window and Editor” on page 2-50
2-6
Change Desktop Colors
You can change the colors used by tools in MATLAB, including the text and background colors, syntax
highlighting colors, and output colors. In MATLAB Online, you also can use themes to change the
colors of the MATLAB desktop, for example, by selecting a dark theme. For more information, see
“MATLAB Online Only: Select Theme” on page 2-10.
In MATLAB Online, the Use system colors check box is not available and this step can be
skipped.
4 Use the Text and Background fields to change the colors. For example, select white for the text
color and black for the background color.
The Syntax Highlighting sample and Command Window sample areas show a preview of the
selected colors.
To restore the default text and background colors, click the Restore Default Colors button at
the bottom of the Preferences window.
The Live Editor automatically selects colors for titles and headings based on the selected background
color. To further customize the colors of titles and headings, use the Customize Styles dialog box or
the matlab.fonts. For more information, see “Format Text in the Live Editor”.
Changing the text and background colors does not change the colors of the toolstrip. In MATLAB
Online, changing the text and background colors also does not change the colors of the Workspace
panel.
2-7
2 Desktop
MATLAB conveys syntax information in code using different colors. This feature, known as syntax
highlighting, helps you to identify syntax elements, such as if/then/else statements, at a glance.
Syntax highlighting appears in code files, in code you enter in the Command Window, and in error
and warning messages. It does not appear in other kinds of output.
The Syntax highlighting sample area shows a preview of the selected colors.
To restore the default syntax highlighting colors, click the Restore Default Colors button at the
bottom of the Preferences window.
To disable syntax highlighting, in the Preferences window, select MATLAB > Editor/Debugger >
Language. Then, in the Syntax highlighting section, clear the Enable syntax highlighting check
box. In MATLAB Online, this option is located under MATLAB > Editor/Debugger > MATLAB
Language.
The Editor also provides syntax highlighting for other languages. To change the syntax highlighting
colors for other languages, in the MATLAB > Editor/Debugger > Language Preferences window,
select a language in the Language field. Then, change the colors for that language. To disable syntax
highlighting for the language, clear the Enable syntax highlighting check box. In MATLAB Online,
these options are located under MATLAB > Editor/Debugger > Other Languages.
For more information about syntax highlighting, see “Check Syntax and Autocomplete Code as You
Type” on page 3-19.
2-8
Change Desktop Colors
To change the colors used for errors, warnings, and links in output:
1 On the Home tab, in the Environment section, click Preferences.
2 Select MATLAB > Colors.
The Command Window sample area shows a preview of the selected colors.
To restore the default output colors, click the Restore Default Colors button at the bottom of
the Preferences window.
In the Editor and Live Editor, MATLAB uses additional colors to identify Code Analyzer messages,
variables, and functions. To change these colors, go to the Home tab, and in the Environment
section, click Preferences. Then, select MATLAB > Colors > Programming Tools. In MATLAB
Online, select MATLAB > Appearance > Colors > Programming Tools.
To change the colors used to identify Code Analyzer messages in the Editor and Live Editor, in the
Code analyzer colors section, select colors from the Warnings and Autofix highlight fields. To
disable highlighting autofixes in the Editor and Live Editor, clear the Autofix highlight check box.
For more information about using the Code Analyzer, see “Check Code for Errors and Warnings Using
the Code Analyzer”.
When you select a variable or function in the Editor or Live Editor, MATLAB highlights all
occurrences of that specific variable or function. To change the color of this highlight, in the Variable
and function colors section, select a color from the Automatically highlight field. To disable
automatic highlighting in the Editor and Live Editor, clear the Automatically highlight check box.
For more information about automatic highlighting, see “Find and Replace Functions or Variables in
Current File”.
MATLAB also uses text of a different color to call out variables with shared scope in the Editor and
Live Editor. To change the color of variables with shared scope, in the Variable and function colors
2-9
2 Desktop
section, select a color from the Variables with shared scope field. To disable calling out variables
with shared scope in the Editor and Live Editor, clear the Variables with shared scope check box.
For more information about variables with shared scope, see “Check Variable Scope in Editor”.
In MATLAB Online, you also can use themes to change the colors of the MATLAB desktop.
Windows and macOS systems support light and dark color schemes. By default, MATLAB Online is
configured to match the current operating system color scheme using the system theme. If the
selected color scheme for the operating system changes, the colors of the MATLAB desktop change to
match the new scheme.
To change the selected theme, on the Home tab, in the Environment section, click Preferences.
Select MATLAB > Appearance and select a theme from the Theme field. For example, select Dark
to select a dark theme or System to select a theme that matches the current operating system
scheme.
The MATLAB Appearance Preferences page shows a preview of the selected theme.
After selecting a theme, you can further customize the colors of the MATLAB desktop by selecting
MATLAB > Appearance > Colors and changing the colors in the Desktop tool colors, MATLAB
syntax highlighting colors, and MATLAB output colors sections.
MATLAB Online saves your color customizations for each available theme. If you customize the colors
of the MATLAB Online desktop and then the MATLAB theme changes to a new theme or to match a
change to the operating system color scheme, your customizations are saved.
2-10
Change Desktop Colors
See Also
matlab.fonts | Preferences
Related Examples
• “Zoom and Change Desktop Fonts” on page 2-2
• “Set Print Options for Command Window and Editor” on page 2-50
2-11
2 Desktop
By default, the quick access toolbar is located at the upper-right corner of the MATLAB desktop. To
change the location of the quick access toolbar, on the Home tab, in the Environment section, click
Layout, and then select an option for the Quick Access Toolbar. Moving the quick access toolbar is
not supported in MATLAB Online.
To add a toolstrip control to the quick access toolbar, right-click the control and then select Add to
Quick Access Toolbar. You also can select from a list of common controls by going to the quick
access toolbar and clicking the button. To remove a control from the quick access toolbar, right-
click the control and select Remove from Quick Access Toolbar. To arrange controls in the quick
access toolbar, drag them to the desired locations.
To further customize the quick access toolbar, click the button on the toolbar and select
Customize Toolbar. Then, select from the options described in “Toolbar Preferences” on page 2-12.
By default, the Current Folder toolbar is located under the toolstrip. To change the location of the
Current Folder toolbar, on the Home tab, in the Environment section, click Layout, and then select
an option for the Current Folder Toolbar. Moving the Current Folder toolbar is not supported in
MATLAB Online.
To add, remove, or rearrange the controls that appear in the Current Folder toolbar, right-click the
toolbar and select Customize. Then, select from the options described in “Toolbar Preferences” on
page 2-12.
Toolbar Preferences
You can customize the quick access and Current Folder toolbars using the Toolbar preferences. To
open the Toolbar preferences, go to the Home tab, and in the Environment section, click
Preferences. Select MATLAB > Toolbars and in the Toolbar section, select the toolbar that you
want to customize.
To rearrange controls in the selected toolbar, in the Layout section, drag the icon for a control or
separator bar to a new location. You also can select a control icon or separator bar and then use the
buttons below the control icons to move the selected control. For example, to move the MATLAB
2-12
Customize MATLAB Toolbars
desktop Cut button to the beginning of the quick access toolbar, select the Cut icon , and then
click the button.
To add or remove controls from the selected toolbar, select or clear the check box for those controls.
For example, to easily create new folders in the current folder, you can add a New Folder button to
the Current Folder toolbar. To do so, select the Folder button and click OK. MATLAB adds the
button to the toolbar.
See Also
Preferences
More About
• “Rerun Favorite Commands” on page 3-13
• “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30
• “Customize Keyboard Shortcuts” on page 2-45
2-13
2 Desktop
When you start MATLAB, the desktop appears in its default layout.
2-14
Change Desktop Layout
To change the desktop layout, you can choose from a set of preconfigured desktop layouts or you can
create your own layout by hiding, minimizing, and undocking individual tools. You also can change
the layout of documents within a tool by undocking, reordering, or tiling them. Then, you can save
your layouts and reuse them again at a later time.
You can use the sidebars to show and hide tools, group them together, and move them from one
location to another. To show or hide a tool, click its icon in the sidebar. To show and hide multiple
tools together, group them by dragging one of the tool icons next to another tool icon. To move a tool
to a different location on the desktop, drag the tool or the icon for the tool to the new location.
For example, if you work mostly in the Command Window, select the All but Command Window
Minimized option (Command Window Only in MATLAB Online) to maximize the Command Window
and minimize all other tools in the desktop.
2-15
2 Desktop
Open Tools
To open or show a tool that is not visible in the desktop, on the Home tab, in the Environment
section, click Layout. Then, in the Show section, select the desktop tool that you want to show on the
desktop. You also can open some tools programmatically using a function. For example, to open the
Editor, use the edit function. To open the Workspace browser, use the workspace function.
In MATLAB Online, to show a tool that is hidden, click its icon in the sidebar. You also can show some
tools by going to the Home tab, and in the Environment section, clicking the Layout button. Then,
in the Layout Options section, select one or more of the options in the list. To open a tool that is not
in any of the sidebars, in a sidebar, click the Open more panels button ( ). Then, in the Open Panel
dialog box, select from the available tools. You also can right-click in a sidebar and select Open more
panels.
2-16
Change Desktop Layout
Minimize Tools
Minimize tools in the desktop to optimize the layout while still maintaining quick access to tools that
you use periodically.
To minimize the toolstrip, at the lower-right corner of the toolstrip, click the
button. The toolstrip minimizes but the
tabs remain visible. To restore the toolstrip, select one of the tabs to display the toolstrip, and then, in
the lower right corner of the toolstrip, click the
button.
To minimize other tools including the Current Folder browser, Command Window, Editor, and Live
Editor, on the title bar of the tool, click the button and select Minimize. The minimized tool
appears along the edge of the desktop indicated by the arrow in the Minimize icon. For example, the
Minimize icon indicates that the tool minimizes to the left edge of the desktop by default. To move
a minimized tool to a different edge of the desktop, drag the tool to the desired location. To open a
minimized tool temporarily on the desktop, click the tool. Then, to restore the tool to its original size,
double-click the tool. Alternatively, you can click the button and select Restore.
For example, to minimize the Current Folder browser, at top right of the Current Folder browser, click
the button and select Minimize. The Current Folder browser minimizes to the left side of the
screen.
2-17
2 Desktop
In MATLAB Online, to minimize a tool, click its icon in the sidebar. If two or more tools are grouped
together, you can minimize each individual tool by clicking the Collapse
button on the left
side of its title bar.
For example, if the MATLAB Online desktop is in the default layout with the Files panel and
Workspace panel open on the left side of the desktop, you can hide both tools by clicking the icon
group for the two tools in the left sidebar. You can minimize just the Files panel by clicking the
Collapse button on
the left side of its title bar.
To minimize tools that open in new windows in MATLAB Online, see “Manage Windows in MATLAB
Online” on page 10-5.
Hide Tools
To hide a tool, click the button on the title bar of a tool and select Close. You also can hide some
tools by going to the Home tab, and in the Environment section, clicking the Layout button. Then,
in the Show section, clear one or more of the options in the list. To hide just the title bar for all tools,
clear the Panel Titles option.
2-18
Change Desktop Layout
In MATLAB Online, to hide a tool, click its icon in the sidebar. You also can hide some tools by going
to the Home tab, and in the Environment section, clicking the Layout button. Then, in the Layout
Options section, clear one or more of the options in the list.
To open a tool in a separate window, undock the tool to move it outside the MATLAB desktop. To
undock a tool, on the title bar of the docked tool, click the button and select Undock. Alternatively,
drag the tool by its title bar to a new location outside of the MATLAB desktop. To move an undocked
tool back into the desktop, at the upper right of the undocked tool, click the button and select
Dock.
You also can undock individual documents within a tool, such as an individual script file open in the
Editor. To undock an individual document, right-click the document tab and select Undock
document. Alternatively, you can click the button on the title bar of the tool and select Undock
document. Undocked tools and documents appear on the Windows task bar, or the equivalent for
your platform. Click the task bar icon for a tool or document to make it active.
For example, if you have the file fact.m open in the Editor, to undock just that file, on the title bar of
the Editor, click the button and select Undock fact.m. MATLAB opens fact.m in a separate
window and leaves the Editor docked in the desktop. To move the file back into the desktop, at the
top right of the undocked file, click the button and select Dock fact.m. If you have multiple
undocked documents and want to move them all back into the desktop, select Dock All in tool.
2-19
2 Desktop
When you open MATLAB documents, they open in the associated tool, such as the Editor, Live Editor,
or Variables editor. Individual documents open as separate tabs within the tool. To optimize the layout
of multiple documents, you can reorder or tile them.
To reorder individual document tabs within a tool, drag the tabs to a different position. To reorder
document tabs alphabetically, on the View tab, in the Document Tabs section, select Alphabetize.
In MATLAB Online, to alphabetize document tabs, on the title bar of the tool, click the button and
select Alphabetize.
By default, the tabs appear at the top of the document. To change the position of the tabs in a tool, on
the View tab, click Tabs Position and select from the available options. For example, to display tabs
on the left side of the Editor instead of at the top, with the Editor open, go to the View tab, click Tabs
Position, and select Left. In MATLAB Online, to change the position of the tabs in a tool, click the
button, select Tabs Position, and select from the available options.
To tile documents in the Editor, Live Editor, and Variables editor, go to the View tab and in the Tiles
section, select a tile option. To move a tiled document, drag the document tab to another tile. If you
drag it to a tile that already contains a document, the document you are dragging covers up the other
document.
For example, to view two files side by side in the Editor, go to the View tab and select the Left/
Right button.
2-20
Change Desktop Layout
To tile documents in the Figures panel or MATLAB web browser, at the top right of the tool, select the
,
,
, or option
button.
In MATLAB Online, to tile documents, on the title bar of the tool, click the button, select Tile All,
and then select a tile option.
If you alternate between two or more customized desktop layouts, you can save them all to easily
switch between them. To save a layout, on the Home tab, in the Environment section, click Layout,
and select Save Layout (or Save Current Layout in MATLAB Online). MATLAB stores all saved
layouts in the preferences folder. MATLAB saves the current desktop layout at the end of a session in
the file MATLABDesktop.xml.
To use a saved layout, on the Home tab, click Layout, and select your saved layout. To delete or
rename saved layouts, select Organize Layouts. In MATLAB Online, right-click the layout and select
Delete or Rename from the context menu.
Some tools, such as the MATLAB web browser and the Variables editor, do not reopen automatically,
even if they were open when you ended the last session. You can use startup options to specify tools
that you want to open on startup. For more information, see “Specify Startup Options” on page 1-19.
See Also
Preferences
2-21
2 Desktop
Related Examples
• “Customize MATLAB Toolbars” on page 2-12
• “Zoom and Change Desktop Fonts” on page 2-2
• “Change Desktop Colors” on page 2-7
2-22
Accessibility in MATLAB
Accessibility in MATLAB
MATLAB provides several features to help make it accessible to users. To navigate MATLAB using just
a keyboard, you can use keyboard shortcuts. In MATLAB Online, you can use a screen reader and a
keyboard to interact with the different tools in MATLAB. To make the desktop more visible, you can
zoom in, change its colors, or increase the clarity of plots. You can also use data sonification to
explore and interpret data by sound.
For our best accessibility support, use MATLAB Online. MathWorks is committed to improving the
accessibility of its software products, focusing first on the accessibility of MATLAB Online. See our
Accessibility Statement for MATLAB for the latest information on accessible workflow support.
In MATLAB Online, to move forward through the different areas of the MATLAB Online desktop, press
Ctrl+F6. To move backward, press Ctrl+Shift+F6. On macOS systems, use the Command key
instead of the Ctrl key. To display a list of navigational keyboard shortcuts, press Ctrl+/.
In an installed version of MATLAB, to move forward through the different areas of the MATLAB
desktop, press Ctrl+Tab. To move backward, press Ctrl+Shift+Tab. To select a toolstrip tab, press
Alt to show the access keys for the tabs and then <character> to select the tab, where
<character> is the displayed access key for the desired tab. After selecting a tab, press
<character> to select an item on the tab, where <character> is the displayed access key for the
desired toolstrip item. Accessing the toolstrip using keyboard shortcuts in an installed version of
MATLAB is not supported on macOS.
For more information, see “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30.
For example, on a Windows system with the NVDA screen reader and MATLAB Online running, enter
individual statements in the Command Window.
1 With the cursor in the Command Window, create a variable named x by entering this statement
in the Command Window.
x = 1
MATLAB adds x to the workspace and displays the results in the Command Window. You hear:
X equals one
Ready prompt
One variable added to workspace
2-23
2 Desktop
When you hear Ready prompt, the Command Window is ready for the next statement at the
command-line prompt (>>).
2 Create another variable y by entering the following statement in the Command Window.
y = cos(x)
Ready prompt
5 Clear all text from the Command Window by entering the following statement in the Command
Window.
clc
You hear:
Ready prompt
For more information, see “Use a Screen Reader in MATLAB Online” on page 2-35.
Zoom
You can adjust the zoom level in MATLAB. The way you zoom differs depending on whether you are
using MATLAB Online or an installed version of MATLAB.
In MATLAB Online, you can zoom in and out of the entire desktop by adjusting the zoom settings for
your web browser.
In an installed version of MATLAB, you can change the zoom level in the Editor and Live Editor. To
zoom in and out, hold the Ctrl key and move the scroll wheel. On macOS systems, use the Command
key instead.
Alternatively, you can zoom in and out using the available keyboard shortcuts.
2-24
Accessibility in MATLAB
For tools such as the Command Window, Current Folder browser, and Workspace browser, you can
increase or decrease the displayed font size using font preferences. For more information, see “Zoom
and Change Desktop Fonts” on page 2-2.
To maximize the space for your current area of focus when zooming, minimize the tools that you are
currently not using. In MATLAB Online, to minimize a tool, click its icon in the sidebar. For example,
if the MATLAB Online desktop is in the default layout with the Files panel and Workspace panel open
on the left side of the desktop, you can hide both tools by clicking the icon group for the two tools in
the left sidebar. If two or more tools are grouped together, you can minimize each individual tool by
clicking the Collapse
button to the left of
its title bar.
In an installed version of MATLAB, to minimize tools such as the Current Folder browser, Command
Window, Editor, and Live Editor, on the title bar of the tool, click the action menu button and select
Minimize. For example, to minimize the Current Folder browser, at top right of the Current Folder
browser, click the action menu button and select Minimize.
For more information about minimizing tools, see “Change Desktop Layout” on page 2-14.
1 In the Command Window, type preferences Colors to open the Preferences window with the
MATLAB Colors Preferences page selected.
2 In the Desktop tool colors section, clear the Use system colors check box.
In MATLAB Online, the Use system colors check box is not available and this step can be
skipped.
2-25
2 Desktop
3 Use the Text and Background fields to change the colors. For example, select white for the text
color and black for the background color.
The Syntax Highlighting sample and Command Window sample areas show a preview of the
selected colors.
To restore the default text and background colors, click the Restore Default Colors button at the
bottom of the Preferences window.
In MATLAB Online, you also can use themes to change the colors of the MATLAB desktop.
To select a theme:
1 In the Command Window, type preferences Appearance to open the Preferences window
with the MATLAB Appearances Preferences page selected.
2 Select a MATLAB Theme. For example, select a dark theme.
For more information about the different ways to change the desktop colors in MATLAB, see “Change
Desktop Colors” on page 2-7.
p = plot([1 2 3; 4 5 6],'LineWidth',2)
title("Three Colored Lines")
legend("Line 1","Line 2", "Line 3")
2-26
Accessibility in MATLAB
Enhance the distinction between the three lines using the LineWidth, Marker, MarkerEdgeColor,
and MarkerSize properties. For more information, see Line Properties.
p(1).LineWidth = 2;
p(1).Marker = "*";
p(1).MarkerEdgeColor = "b";
p(1).MarkerSize = 8;
p(2).LineWidth = 3;
p(2).Marker = "diamond";
p(3).LineWidth = 4;
2-27
2 Desktop
To change the font size for objects in a plot, you can use the fontsize function. For example,
increase the font size of the title, legend, and axes labels in the plot until they are more easily
readable.
fontsize(gcf,"increase")
fontsize(gcf,"increase")
fontsize(gcf,"increase")
To improve the contrast of lines and markers within a plot, you can use the colororder function and
specify the "dye" color palette. The colors on the "dye" palette meet international contrast ratio
standards for enhanced accessibility against a white background. For example, specify the "dye"
color palette for the plot.
colororder("dye");
2-28
Accessibility in MATLAB
y = sin(1:10);
[s,Fs] = sonify(y);
You can use the sonified data with the audioplayer function to play, pause, resume, and stop the
sound. You also can write the sonified data to a WAV file using the audiowrite function.
See Also
matlab.fonts | sonify
Related Examples
• “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30
• “Use a Screen Reader in MATLAB Online” on page 2-35
• “Zoom and Change Desktop Fonts” on page 2-2
• “Change Desktop Colors” on page 2-7
• Accessibility Statement for MATLAB
2-29
2 Desktop
Installed MATLAB
If you have MATLAB installed on your system, this table describes the actions and related keyboard
shortcuts useful for navigating MATLAB without a mouse.
2-30
Use Keyboard Shortcuts to Navigate MATLAB
You cannot customize most of these shortcuts. For information about customizable keyboard
shortcuts and how to view and modify them, see “Customize Keyboard Shortcuts” on page 2-45.
MATLAB Online
MATLAB Online provides access to MATLAB from a standard web browser. Because MATLAB Online
runs in a browser, navigation using the keyboard is slightly different.
This table describes the actions and related keyboard shortcuts useful for navigating MATLAB Online
without a mouse.
2-31
2 Desktop
This table describes the actions and related keyboard shortcuts useful for navigating figures in
MATLAB Online without a mouse.
When focus is on the figure, this means Tab steps into the
axes. If there are multiple axes in a figure, and focus is on
the first axes, then Tab steps to the next axes.
2-32
Use Keyboard Shortcuts to Navigate MATLAB
This table describes several of these actions and their related keyboard shortcuts. For additional
keyboard shortcuts, see the documentation for a specific tool or feature.
For example, if you click the name of the Edit menu, the
whole menu appears. Pressing Esc hides the menu again.
You cannot customize these shortcuts. For information about customizable keyboard shortcuts and
how to view and modify them, see “Customize Keyboard Shortcuts” on page 2-45.
2-33
2 Desktop
See Also
More About
• “Customize Keyboard Shortcuts” on page 2-45
• “Rerun Favorite Commands” on page 3-13
• “Customize MATLAB Toolbars” on page 2-12
• “Accessibility in MATLAB” on page 2-23
2-34
Use a Screen Reader in MATLAB Online
To improve the screen reader experience when working in the Command Window, suppress excess
blank lines in output for the current session using the format command.
format compact;
To maintain the compact format across all future sessions, use settings to set the personal value for
line spacing in output display.
s = settings;
s.matlab.commandwindow.DisplayLineSpacing.PersonalValue = "compact";
When working with graphics objects, view and modify properties programmatically or use the
Property Inspector. For example, the plot function returns a chart line object. You can use dot
notation to view and set properties.
p = plot(1:10,1:10);
p.LineWidth = 3;
Alternatively, you can set properties using name-value arguments when creating the object, such as
plot(1:10,1:10,"LineWidth",3).
For more information about viewing and modifying graphics object properties, see “Modify Graphics
Objects”.
For the best experience when viewing and searching the documentation using a screen reader, open
it in a separate browser tab or window at https://www.mathworks.com/help/.
If you run MATLAB without the desktop using the -nodesktop startup option, these tips can help
improve your screen reader experience:
• Use the format function to suppress excess blank lines in output, making it easier to navigate
diary files. For more information, see “Reduce Blank Lines in Output” on page 2-35.
2-35
2 Desktop
• Include a filename when calling the diary function to save the Command Window text to a
separate file. You can call the diary function multiple times during a MATLAB session with
different filenames to save different sets of text to different files.
For a more accessible alternative to using MATLAB with the -nodesktop option, use the Command
Window Only layout in MATLAB Online instead. Using the Command Window Only layout in MATLAB
Online gives you access to more keyboard shortcuts and the full functionality of the MATLAB desktop.
To select the Command Window Only layout in MATLAB Online, go to the Home tab, and in the
Environment section, click the Layout button and then select Command Window Only.
To move forward through the different areas of the MATLAB Online desktop, press Ctrl+F6 (or
Command+F6 on macOS systems). To move backward, press Ctrl+Shift+F6 (or Command+Shift
+F6 on macOS systems). You also can use a keyboard shortcut to navigate directly to some open
tools.
This table describes the different areas of the MATLAB Online desktop and their default positions.
For example, you can use the toolstrip to send feedback about the current release:
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 With the cursor in the Command Window, press Ctrl+F6 to navigate to the toolstrip. You hear:
2-36
Use a Screen Reader in MATLAB Online
Toolstrip region
Toolstrip tab control
Home tab selected one of three
3 Press the Tab key to enter the Home tab and then continue pressing the Tab key until you reach
the Feedback button. You hear:
Feedback button
Send us feedback or report a bug
4 Press Enter. The Send Feedback dialog box opens.
5 Pres Esc twice to close the dialog box without sending feedback.
For more information about the MATLAB desktop, see “Change Desktop Layout” on page 2-14.
For example:
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 With the cursor in the Command Window, create a variable named x by entering this statement
in the Command Window.
x = 1
MATLAB adds x to the workspace and displays the results in the Command Window. You hear:
x equals one
Ready prompt
One variable added to workspace
When you hear Ready prompt, the Command Window is ready for the next statement at the
command prompt (>>).
3 Create another variable y by entering this statement in the Command Window.
y = cos(x)
You hear:
x = y
You hear:
2-37
2 Desktop
Ready prompt
7 Save the variables from the current workspace in the file test.mat by entering this statement in
the Command Window.
save test.mat
Ready prompt
8 Remove the variables from the workspace by entering this statement in the Command Window.
clear
You hear:
clc
You hear:
Ready prompt
For more information about entering statements in the Command Window, see “Enter Statements in
Command Window” on page 3-2.
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 Navigate to the toolstrip by pressing Ctrl+F6 until you hear:
Toolstrip region
Toolstrip tab control
Home tab selected one of three
3 Press the Tab key to enter the Home tab. The New Script button is selected. You hear:
Home property page
File grouping
New script button
Create a new script in the current folder
2-38
Use a Screen Reader in MATLAB Online
4 Press Enter to create a new script. MATLAB creates the script file and opens it in the Editor. You
hear:
n = 50;
r = rand(n,1);
sz = size(r)
m = mean(r)
6 Press Ctrl+S to save the file. MATLAB opens the Save As dialog box. You hear:
Save as dialog
Alternatively, you can open the Save As dialog box using the Save button on the toolstrip.
7 Enter a name for the script. For example, enter the name myrandom.m. Press Enter to save the
file.
8 To run the script, make sure that focus is inside the script, and then press F5. If focus is not
inside the script, pressing F5 reloads MATLAB Online in the browser.
MATLAB runs the script and displays the output in the Command Window. You hear:
Alternatively, you can run the script using the Run button on the toolstrip.
9 Use the arrow keys to navigate through the lines in the script and edit the code. For example, go
to line 1 in the code by pressing the Up Arrow key until you hear:
Line feed
11 Delete the semicolon (;) and save your changes by pressing Ctrl+S.
12 Press F5 to run the edited script. You hear:
n equals fifty
sz equals fifty one
m equals zero point four five zero four
Ready prompt
2-39
2 Desktop
For example, create and run a live script that calculates the area and volume of a sphere:
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 Navigate to the toolstrip by pressing Ctrl+F6 until you hear:
Toolstrip region
Toolstrip tab control
Home tab selected one of three
3 Press the Tab key twice to enter the Home tab and select the New Live Script button. You hear:
New live script button
Create a new live script in the current folder
4 Press Enter to create a new live script. MATLAB creates the live script file and opens it in the
Live Editor. You hear:
[x,y,z] = sphere;
r = 1;
A = 4*pi*r^2
V = (4/3)*pi*r^3
6 To run the live script, make sure that focus is inside the live script, and then press F5. If focus is
not inside the script, pressing F5 reloads MATLAB Online in the browser.
MATLAB runs the live script and displays the output to the right of the code, by default. You hear:
Running untitled.mlx
untitled.mlx run complete two outputs created
Six variables added to workspace
Ready prompt
Alternatively, you can run the live script using the Run button on the toolstrip.
7 Move focus to the output by pressing Ctrl+Shift+O. You hear:
Variable output
V equals four point one eight eight eight
8 Press the Up Arrow key to move to the previous output. You hear:
Variable output
A equals twelve point five six six four
9 Move focus back to the code by pressing Ctrl+Shift+O. You hear:
Edit multiline
Code line three has output
A equals four star pi star r two
10 Go to the top of the document by pressing the Up Arrow key until you hear:
2-40
Use a Screen Reader in MATLAB Online
For more information about creating live scripts, see “Create Live Scripts in the Live Editor”.
Open and Close Scripts and Live Scripts Using a Screen Reader
You can open and close existing MATLAB code files, including scripts and live scripts, using a screen
reader and a keyboard.
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 With the cursor in the Command Window, open myrandom.m by entering this statement in the
Command Window.
open myrandom.m
You hear:
Edit multiline
Start of document
line one n equals 50
Alternatively, you can open the script using the Open button on the toolstrip.
3 To close myrandom.m, press Ctrl+Shift+F6 to move out of the document. You hear:
Tab control
myrandom.m tab selected
C MyWork myrandom.m one of one
4 Press the Delete key to close the document. You hear:
For more information about additional file actions, see “Manage Files and Folders” on page 6-35.
For example:
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 With the cursor in the Command Window, create a variable named x by entering this statement
in the Command Window.
x = 1:5
2-41
2 Desktop
MATLAB adds x to the workspace and displays the results in the Command Window. You hear:
When you hear Ready prompt, the Command Window is ready for the next statement at the
command prompt (>>).
3 Create another variable y by entering this statement in the Command Window.
y = 2*x
You hear:
plot(x,y)
You hear:
Figure 1
The current axes object contains one object of type line
5 Move the cursor back to the Command Window by pressing Ctrl+F6 until you hear:
title("My Plot")
legend
You hear:
Figure 1
The current axes object contains one object of type line
8 Navigate to the new figure tab by pressing Ctrl+F6 until you hear:
Tab control
Figure 1 tab selected
Figure 1, one of one
9 Press Tab twice to select the figure axes.
You hear:
Figure 1
The current axes object contains one object of type line
The axes object with title my plot contains one object of type line
2-42
Use a Screen Reader in MATLAB Online
10 Type NVDA Modifier Key+Space to switch to focus mode for the figure axes. By default, the
NVDA modifier key is the Insert key.
11 Type Ctrl+Down Arrow to select the title inside the axes.
You hear:
Text my plot
12 Press Tab to select the line object. If axes contain multiple objects, press Tab to navigate
through them.
For more information about exploring plotted data, see “Interactively Explore Plotted Data”.
1 On a Windows system with the NVDA screen reader running, open a Google Chrome browser and
start MATLAB Online.
2 With the cursor in the Command Window, delete myrandom.m by entering this statement in the
Command Window.
delete myrandom.m
You hear:
Ready prompt
Alternatively, you can delete the script using the Files panel:
Files region
Table
3 Select myrandom.m by pressing the Up or Down Arrow key until you hear:
For more information about additional file actions, see “Manage Files and Folders” on page 6-35.
2-43
2 Desktop
See Also
More About
• “Accessibility in MATLAB” on page 2-23
• “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30
• “Desktop Basics”
2-44
Customize Keyboard Shortcuts
Keyboard shortcuts are useful for accessing desktop features quickly. To optimize your experience,
you can customize the current set of keyboard shortcuts in MATLAB.
There are several ways you can modify the current set of keyboard shortcuts. You can:
To view or modify the current set of keyboard shortcuts, use the Keyboard Shortcuts Preferences
options in the Preferences Window. To open the Keyboard Shortcuts Preferences page in the
Preferences Window, go to the Home tab, and in the Environment section, click Preferences.
Then, select MATLAB > Keyboard > Shortcuts.
For actions that are not performed with a menu item, to find keyboard shortcuts, open the Keyboard
Shortcuts Preferences page in the Preferences Window. Then, in the search box, enter the name of
the tool or action for which you want to see the keyboard shortcuts. For example, type Editor
clear to find the keyboard shortcut for clearing selected text in the Editor.
To view the shortcuts for an action, select the action name. For example, select Clear Selection.
MATLAB displays the keyboard shortcuts for the selected action. For example, the keyboard shortcut
for the Clear Selection action in the Editor is the Escape key.
2-45
2 Desktop
You can create a list of all the keyboard shortcuts in the current set by copying them to the clipboard
and pasting them in a text file or spreadsheet application, such as Microsoft Excel®. For the best
formatting, use a spreadsheet application. To copy all the keyboard shortcuts, open the Keyboard
Shortcuts Preferences page in the Preferences Window. Click the Actions button and from the
drop-down menu, choose Copy to Clipboard. Paste the data into the desired application.
Customizing a keyboard shortcut is useful if you frequently perform an action and the action does not
have a keyboard shortcut defined, or if the defined keyboard shortcut is hard to use or conflicts with a
different shortcut. For an overview on customizing keyboard shortcuts, watch the Customizable
Keyboard Shortcuts video. You must have an internet connection to watch the video.
1 Open the Keyboard Shortcuts Preferences page in the Preferences Window and, in the search
box, type an existing keyboard shortcut or the name of an action, tool, or menu.
For example, you can type Ctrl+R (shortcut), Delete (action), Command Window (tool), or File
(menu).
You can enter most keyboard shortcuts by either pressing keystrokes or typing the key names. If
using keystrokes for a keyboard shortcut does not work, try typing the key names instead. For
example, if pressing the Ctrl key and then R does not work, try typing the text Ctrl+R.
MATLAB displays the list of matching actions for which you can customize or define a keyboard
shortcut. If you specify the name of a tool, MATLAB displays actions associated with the tool or
menu, as well as any action names that contain the specified text.
2 Select the name of the action for which you want to define or modify a keyboard shortcut.
3
Click the Add button .
2-46
Customize Keyboard Shortcuts
4 Specify the keystrokes you want to use for the keyboard shortcut.
A keystroke can be a single key or the combination of a modifier (Alt, Shift, or Ctrl) and another
key. Specify a keystroke by performing it, not by typing the names of the keys character by
character. For example, press the Ctrl key and the Y key. Do not type C-t-r-l-+-Y.
To specify multiple keystrokes for one action, or to limit the number of keystrokes for an action,
click the down arrow next to the key icon in the Shortcuts box. Then, select either Limit to
1 keystroke, Limit to 2 keystrokes, or Limit to 3 keystrokes. For example, to
specify Ctrl+Y, Shift+Z, F9 as the three keystrokes for an action, select Limit to 3
keystrokes and then type the keystrokes.
5 In the Tools with shortcut column, click the down arrow and select which tools you want to
assign the keyboard shortcut to.
6 Evaluate and resolve any conflicts, indicated by the error icon and informational icon . The
error icon indicates that two different actions within the same tool have the same shortcut.
The informational icon indicates that two different actions in two different tools have the same
shortcut.
There is no requirement to resolve keyboard shortcut conflicts. However, if the same shortcut
specifies two different actions, the shortcuts can be confusing to use. Resolving all conflicts
indicated by the error icon is recommended, although in some situations, resolving a conflict
might be unnecessary. For example, resolving the conflict might be unnecessary if the conflict is
temporary or the two actions are associated with different modes of the same tool. Resolving
conflicts indicated by the informational icon is recommended if you use both tools frequently
and you perform both actions frequently.
To resolve a conflict, change or delete shortcuts such that there is a one-to-one correspondence
between shortcuts and frequently used actions.
7 Click OK or Apply.
New or modified keyboard shortcuts become available immediately. Changed shortcuts that
correspond to menu items immediately appear in the menu.
To delete a keyboard shortcut for a selected action, select the keyboard shortcut that you want to
delete and click the Delete button .
2-47
2 Desktop
If you modify keyboard shortcuts, and then decide you do not want to keep the changes, you can
restore the default shortcuts. To restore the default state of a keyboard shortcut, click the Actions
button and select Undo Modifications to <Set Name> Default Set (modified), where <Set
Name> is the name of the modified default set.
Note Undoing modifications reverts all keyboard shortcuts changes that you made to the set. You
cannot undo modifications on a shortcut-by-shortcut basis.
There are some actions and tools for which you cannot change the keyboard shortcuts. Actions for
which the keyboard shortcut cannot be customized do not appear when you search for them in the
Keyboard Shortcuts Preferences page in the Preferences Window. Examples of these actions
include canceling the current action (Esc), interrupting MATLAB execution (Ctrl+C), and some of the
navigational actions described in “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30.
In addition, you cannot change the keyboard shortcuts associated with these tools or portions of
tools:
• Figure windows — For example, you cannot modify the keyboard shortcut, Ctrl+S, for saving a
MATLAB .fig file.
• Toolboxes — For example, you cannot modify keyboard shortcuts in the SimBiology® desktop.
• Incremental search — You can modify the keyboard shortcuts for initiating a forward or backward
incremental search. However, you cannot change the keyboard shortcuts that you use within
incremental search mode, such as Ctrl+Shift+S to search forward.
• Dialog boxes — For example, you cannot create a keyboard shortcut for the OK button.
By default, MATLAB uses the keyboard shortcut settings for your current platform. To select a
different set of keyboard shortcuts, open the Keyboard Shortcuts Preferences page in the
Preferences Window and, in Active settings, select from the available options. To use a keyboard
shortcut settings file that is on your system but not in the Active settings list, select Browse... to
find and select the desired file.
This table lists the keyboard shortcut settings files installed with MATLAB.
2-48
Customize Keyboard Shortcuts
You also can download keyboard shortcut settings files from File Exchange. For example, to restore
the MATLAB default keyboard shortcuts that were in place for MATLAB Version 7.9 (R2009a) and
earlier releases, go to File Exchange and search for MATLAB Desktop R2009a Default
Keyboard Shortcut sets. Download and extract the set and then select it as the active settings
file. A valid keyboard shortcut settings file appears with a keyboard key icon .
1 Open the Keyboard Shortcuts Preferences page in the Preferences Window and click the
Actions button .
2 From the drop-down menu, choose the set of keyboard shortcuts to which you want to compare
the current set.
3 The Comparison Tool opens and displays the two keyboard shortcut sets side-by-side. For more
information about how to read the results, see “Compare Text Files” on page 6-11.
Saving a set of keyboard shortcuts to a settings file is useful if you want to:
• Save the changes you make to a default keyboard shortcut set to a new set.
• Use a set of customized keyboard shortcuts on another system running MATLAB.
• Overwrite a previously saved set of keyboard shortcuts.
• Share a set of keyboard shortcuts with others, for example, on File Exchange.
To save a keyboard shortcut settings file, open the Keyboard Shortcuts Preferences page in the
Preferences Window. Then, click the Actions button and select Save As. MATLAB saves the file
as an .xml file in the folder that you specify.
You cannot overwrite the default settings files that install with MATLAB. MATLAB saves modifications
that you make to a default set using the name of the default set appended with the text (modified),
for instance, Windows default (modified).
To delete a previously saved set of keyboard shortcuts, open the Keyboard Shortcuts Preferences
page in the Preferences Window and in Active settings, select the set of keyboard shortcuts that you
want to delete. Click the Actions button and select Delete filename, where filename is the
name of a keyboard shortcut set you want to delete. You cannot delete default keyboard shortcut sets,
such as Windows Default Set.
See Also
More About
• “Use Keyboard Shortcuts to Navigate MATLAB” on page 2-30
• “Rerun Favorite Commands” on page 3-13
• “Customize MATLAB Toolbars” on page 2-12
2-49
2 Desktop
You can customize how pages look when printing from the Command Window and Editor.
To specify page setup options, open the Page Setup dialog box using one of these methods:
• Command Window — Right-click in the Command Window and select Page Setup.
• Editor — Go to the Editor tab, and in the File section, select Print > Page Setup.
The Live Editor has a different way of controlling how pages look when printing. To change the page
setup options when exporting in the Live Editor, use settings. For more information, see the
matlab.editor.export settings described in matlab.editor.
Add Header
When printing from the Command Window or Editor, you can include a header on each printed page.
The header includes information such as the current date and time, the name of the file you are
2-50
Set Print Options for Command Window and Editor
printing, and the page number. To include a header, in the Page Setup dialog box, select the Layout
tab and then select Print header.
To change the format and layout of the header, select the Header tab and then select from the
available options, as described in the table below. (On macOS platforms, select MATLAB in the
Settings menu to see the Header tab.) The preview area shows a sample of the header with the
selected options.
For example, in the Editor, print the example file fourier_demo2.m with a standard two line header
and a double line border.
2-51
2 Desktop
Change Fonts
You can specify the font to use when printing. By default, MATLAB uses the Editor or Command
Window font when printing.
1 In the Page Setup dialog box, select the Fonts tab. (On macOS platforms, select MATLAB in the
Settings menu to see the Fonts tab.)
2 In the Choose font field, select Header to change the font for the header text, or Body to
change the font for all of text in Command Window or Editor except for header text.
3 Select Use custom font and then specify the font name, style, and size. The Sample area shows
a preview of the selected font.
See Also
print | matlab.editor
Related Examples
• “Print Figure from File Menu”
• “Zoom and Change Desktop Fonts” on page 2-2
• “Change Desktop Colors” on page 2-7
2-52
Web Browsers and MATLAB
The system web browser that MATLAB uses depends on your platform:
2-53
2 Desktop
• On Microsoft Windows and Apple Macintosh platforms, MATLAB uses the default web browser for
your operating system.
• On UNIX® platforms, MATLAB uses the Mozilla Firefox web browser. You can specify a different
system web browser for MATLAB using Web preferences on page 2-55.
The MATLAB web browser may not support all the features that a particular website or HTML page
uses. For example, the MATLAB web browser does not display .bmp (bitmap) image files. Instead
use .gif or .jpeg formats for image files in HTML pages.
To display an HTML document in the MATLAB web browser, double-click the document name in the
Current Folder browser.
• MATLAB supports non-authenticated, basic, digest, and NTLM proxy authentication types.
• If a proxy with basic authentication is specified, MATLAB only supports HTTP connections. HTTPS
connections are not supported.
• You cannot specify the proxy server settings using a script.
• There is no automated way to provide the proxy server settings your system web browser uses to
MATLAB.
1 On the Home tab, in the Environment section, click Preferences. Select MATLAB > Web.
2 Select the Use a proxy server to connect to the Internet check box.
3 Specify values for Proxy host and Proxy port.
Examples of acceptable formats for the host are: 172.16.10.8 and ourproxy. For the port,
enter an integer only, such as 22. If you do not know the values for your proxy server, ask your
system or network administrator for the information.
If your proxy server requires a user name and password, select the Use a proxy with
authentication check box. Then enter your proxy user name and password.
4 Ensure that your settings work by clicking the Test connection button.
• If MATLAB can access the Internet, Success! appears next to the button.
• If MATLAB cannot access the Internet, Failed! appears next to the button. Correct the values
you entered and try again. If you still cannot connect, try using the values you used when you
authenticated your MATLAB license.
5 Click OK to accept the changes.
6 Restart MATLAB to enable the changes.
2-54
Web Browsers and MATLAB
1 On the Home tab, in the Environment section, click Preferences. Select MATLAB > Web.
2 Under System Web browser, in the Command field, specify the system command to open the
browser, for example, opera, which opens the Opera Web browser.
3 Add options for opening your system web browser in the Options field. For example, geometry
1064x860 specifies the size of the window for Opera.
4 Click OK.
Note If you specify Firefox as the system web browser using the system command firefox, specify
a display option to ensure that the browser opens correctly.
See Also
web
More About
• “Web Preferences” on page 2-67
2-55
2 Desktop
Note Some options for license actions require an internet connection. If your internet connection
requires a proxy server, use MATLAB web preferences to specify the server host and port. See
“Specify Proxy Server Settings for Connecting to the Internet” on page 2-54 for more information.
If the Update Current Licenses option is not present, then your license
updates automatically and no action is required from you.
MathWorks Account 1 Sign in to mathworks.com. If you are already signed in, select My
Account from the drop-down menu under your account icon.
2 Under My Software, click the license you want to update. If you have
more licenses than fit on the screen, click View additional Licenses or
Trials and then click the license you want. Clicking a license takes you to
the License Center.
3 In the License Center, click the Install and Activate tab.
4 Click Update License File. If this option is not present, then the license
updates automatically and no action is required from you.
5 Click one of the icons under Get License File. You can download the
license file or have it emailed to you.
6 Follow all prompts.
MathWorks retrieves the most current version of the license file for the license.
You need to restart MATLAB.
Activate Software
The simplest way to activate your software is from within MATLAB. You should perform this task
within your MathWorks Account only if your computer cannot communicate with MathWorks. For
additional details on activation, see “Activate MATLAB Installation Manually”.
2-56
Manage Your Licenses
MATLAB starts the activation application, which walks you through the
activation process. Answer the questions on each dialog box, select the license
you want to activate, and click Activate.
MathWorks Account 1 Sign in to mathworks.com. If you are already signed in, select My
Account from the drop-down menu under your account icon.
2 Under My Software, click the license you want to activate. If you have
more licenses than fit on the screen, click View additional Licenses or
Trials, and then click the license you want.
3 Click the Install and Activate tab.
4 Click Activate to Retrieve License File or Activate a Computer.
5 Follow all prompts.
Deactivate Software
Although you can deactivate the software from within MATLAB, if you cannot access the computer to
deactivate, you can still deactivate the software from your MathWorks Account.
For more details on deactivating MathWorks software, see “Deactivate MATLAB License”.
MATLAB displays a list of all your MathWorks licenses on this computer, with
their status. When you select a license and click Deactivate, MATLAB
deactivates all releases on this computer associated with the license, and
updates the licensing information at the MathWorks website. You will not be
able to use MathWorks software with that license on this computer.
If you are not connected to the Internet, MATLAB deactivates the licenses on
your computer but cannot update the corresponding license information stored
at the MathWorks website. In this scenario, MATLAB returns a deactivation
string. To complete deactivation, save a copy of this string, go to a computer
with an internet connection, and visit the License Center at the MathWorks
website. There you can sign in to your MathWorks Account and enter the
deactivation string.
2-57
2 Desktop
MathWorks deactivates all releases on the specified computer, and updates the
licensing information in License Center.
If you are linking a network license, you may need to get the license number
from your organization's license administrator.
Get a Trial
Start a free 30-day trial of MathWorks software.
Although you can get a trial from within MATLAB or from your MathWorks Account, the simplest way
is to go directly to Free MATLAB Trial on mathworks.com.
See Also
license
2-58
Manage Your Licenses
Related Examples
• “Install Products”
• “Administer Network Licenses”
2-59
2 Desktop
If a more recent version is available, a notification displays in MATLAB when you start the program.
To install the MATLAB update, click the notification icon and then select Install Update. If you click
the notification but decide not to install the update, the notification is cleared; however, you can still
install the update at a later time.
You also can check for updates manually. You must have an active internet connection to check for
and update your installation.
On the Home tab, click Help > Check for Updates. The Add-On Manager opens with the Updates
tab selected. If there is an update available for your version of MATLAB, click the Update button to
the right of the update name to install it. If there is no update available for your version or if you have
already installed the latest update, MATLAB displays that information.
In R2019a: On the Home tab, click Help > Check for Updates > Products. If there is an update
available, click Install Update.
Before R2019a: On the Home tab, click Add-Ons > Check for Updates > Products.
See Also
More About
• “Get New MATLAB Release”
• “Get and Manage Add-Ons” on page 8-2
2-60
macOS Platform Conventions
Make the following replacements to adjust documented mouse instructions for Macintosh platforms if
you are using a one-button mouse:
To view the contents of the MATLAB root folder in the Mac Finder, right-click the MATLAB
application bundle, and then select Show Package Contents from the context menu.
To view the content of the MATLAB root folder from within MATLAB:
1
On the Home tab, in the File section, click .
2 In the File Browser dialog box, press Command+Shift+G to open the Go To Folder dialog box.
3 Enter the full path to a folder within the MATLAB application package, for example, /
Applications/MATLAB_R2019a.app/bin.
4 Press Go.
To open a file with a MATLAB command, such as edit, specify the full path of the MATLAB root
folder. For example:
edit(fullfile(matlabroot,'/toolbox/matlab/demos/lotka.m'))
2-61
2 Desktop
of MATLAB to start additional instances rather than trying to keep multiple MATLAB icons in the
Dock.
2-62
Where MATLAB Stores Preferences
MATLAB and other MathWorks products store their preferences in the preferences folder. To see the
full path for the preferences folder type prefdir in the MATLAB Command Window. The name of the
preferences folder matches the name of the release. For instance, for release R2016b, the name of
the preferences folder is R2016b.
On macOS and iOS, the preferences folder might be inside another folder that is hidden. If so, to
access the hidden folder:
You must have write access to the preferences folder. Otherwise, MATLAB generates an error in the
Command Window when you try to change preferences. MATLAB also can generate an error if the
preferences folder is hidden.
• Windows— C:\Users\username\AppData\Roaming\MathWorks\MATLAB\release
• Linux — ~/.matlab/release
• macOS — ~/Library/Application Support/MathWorks/MATLAB/release
If you make changes to preferences while MATLAB is using the temporary preferences folder, the
preferences persist across sessions. But, once the issue is resolved that was preventing MATLAB from
accessing the preferences folder, any changes made to the preferences while using the temporary
preferences folder are lost.
Each version of MATLAB can have a temporary preferences folder. MATLAB does not migrate
preferences from the temporary preferences folder across releases.
2-63
2 Desktop
See Also
prefdir | Preferences
Related Examples
• “Import Preferences from Other Releases” on page 2-65
2-64
Import Preferences from Other Releases
• MATLAB looks for a preferences folder for release R2019b or newer. If MATLAB finds one or more
preferences folders matching that criteria, it migrates the files from the most recent version.
For example, if you start R2021b and preferences folders exist for both the R2020b and R2019b
releases, then MATLAB migrates the files from the R2020b preferences folder to the R2021b
preferences folder.
Note For releases before R2021b, MATLAB looks back three releases. For example, if you start
R2019a, MATLAB looks for preferences from R2018b, R2018a, and R2017b.
• If a preferences folder does not exist from a valid previous release, then MATLAB creates the
default preference files for the release starting up.
For example, if you start R2021a, MATLAB looks for preferences for versions R2020b, R2020a,
and R2019b. If none of those is installed, MATLAB creates the default files for the R2021a release.
This is true even if a preferences folder exists for the R2019a release or earlier.
• If you install a release older than the current version, MATLAB does not import preferences from
releases that are newer than that release.
To see the full path for the preferences folder, type prefdir in the MATLAB Command Window. The
name of the preferences folder matches the name of the release you are running. For example, for
MATLAB R2021a, the name of the preferences folder is R2021a.
prefdir
ans =
'C:\Users\username\AppData\Roaming\MathWorks\MATLAB\R2021a'
On macOS and iOS, the preferences folder might be inside another folder that is hidden. If so, to
access the hidden folder:
1 In the Finder, select Go > Go to Folder.
2 In the resulting dialog box, type the path returned by prefdir, and then press Enter.
For example, to use the default preferences for R2021a, start MATLAB, and in the Command Window,
type prefdir to determine the location of the preferences folder.
prefdir
ans =
'C:\Users\username\AppData\Roaming\MathWorks\MATLAB\R2021a'
2-65
2 Desktop
Alternatively, if you have not started the new release yet, create an empty preferences folder for it.
This will prevent MATLAB from importing preferences when you do open the new release, and force
it to use the default preferences instead. For example, to use the default preferences for MATLAB
R2021a, if your MATLAB preferences are stored in the C:\Users\username\AppData\Roaming
\MathWorks\MATLAB folder, create the folder C:\Users\username\AppData\Roaming
\MathWorks\MATLAB\R2021a.
See Also
prefdir | Preferences
Related Examples
• “Where MATLAB Stores Preferences” on page 2-63
2-66
Web Preferences
Web Preferences
Limitations
• MATLAB supports nonauthenticated, basic, digest, and NTLM proxy authentication types.
• You cannot specify proxy server settings using a script.
• There is no automated way to provide MATLAB with the proxy server settings that your system
browser uses.
You can set Web preferences on the Home tab, in the Environment section. Click Preferences.
Select MATLAB > Web, and then adjust preference options as described in this table.
Preference Usage
Use a proxy server to connect to Provide information that MATLAB needs to access the Internet when your
the Internet network uses a firewall or another method of protection that restricts
internet access.
Proxy host Specify a value for the Proxy host. For example, 172.16.10.8 or
ourproxy. If you do not know the values for your proxy server, ask your
system or network administrator for the information.
Proxy port Specify an integer value for the Proxy port. For example, 22. If you do
not know the values for your proxy server, ask your system or network
administrator for the information.
Use a proxy with authentication Specifies that your proxy server requires a user name and password.
Proxy username Specify the proxy server user name.
Proxy password Specify the proxy server password.
Test connection Ensure that your settings work.
Specify the system Command to use to open the system browser. For
example, opera, opens the Opera Web browser.
Specify the Options to use for the system browser. For example,
geometry 1064x860 specifies the size of the window for Opera.
If you specify Firefox as the system browser using the system command
firefox, specify a display option to ensure that the browser opens
correctly.
2-67
3
Entering Commands
As you work in MATLAB, you can enter individual statements in the Command Window. For example,
create a variable named a by typing this statement at the command line:
a = 1
MATLAB immediately adds variable a to the workspace and displays the result in the Command
Window.
a =
When you do not specify an output variable, MATLAB uses the variable ans, short for answer, to
store the results of your calculation.
sin(a)
ans =
0.8415
The value of ans changes with every command that returns an output value that is not assigned to a
variable.
If you end a statement with a semicolon, MATLAB performs the computation, but suppresses the
display of output in the Command Window.
b = 2;
To enter multiple statements on multiple lines before running any of the statements, use Shift+Enter
between statements. This action is unnecessary when you enter a paired keyword statement on
multiple lines, such as for and end.
You also can enter more than one statement on the same line by separating statements. To distinguish
between commands, end each one with a comma or semicolon. Commands that end with a comma
display their results, while commands that end with a semicolon do not. For example, enter the
following three statements at the command line:
A =
17 24 1 8 15
23 5 7 14 16
4 6 13 20 22
10 12 19 21 3
11 18 25 2 9
C =
3.6170 5.1064 0.2128 1.7021 3.1915
4.8936 1.0638 1.4894 2.9787 3.4043
0.8511 1.2766 2.7660 4.2553 4.6809
2.1277 2.5532 4.0426 4.4681 0.6383
2.3404 3.8298 5.3191 0.4255 1.9149
3-2
Enter Statements in Command Window
To recall previous lines in the Command Window, press the up- and down-arrow keys, ↑ and ↓. Press
the arrow keys either at an empty command line or after you type the first few characters of a
command. For example, to recall the command b = 2, type b, and then press the up-arrow key.
To clear a command from the Command Window without executing it, press the Escape (Esc) key.
You can evaluate any statement already in the Command Window. Select the statement, right-click,
and then select Evaluate Selection.
In the Command Window, you also can execute only a portion of the code currently at the command
prompt. To evaluate a portion of the entered code, select the code, and then press Enter.
hello
See Also
Command Window
Related Examples
• “Check Syntax and Autocomplete Code as You Type” on page 3-19
• “Set Command Window Preferences” on page 3-15
3-3
3 Entering Commands
1
In the Command Window, click the Browse for functions button to the left of the prompt. The
Function browser opens.
Tip The Function browser closes when you move the pointer outside of it. To keep the browser
open, drag it by the top edge to a different location.
2 Optionally, select a subset of products to display in the list. Click the product area at the bottom
of the browser (where the text All installed products appears by default), and then set the
Selected Products preference and click OK.
3 Find functions by browsing the list or by typing a search term. For example, search for the term
fourier.
3-4
Find Functions to Use
In the search results, a parenthetical term after a function name indicates either that the
function is in a product folder other than MATLAB, or that there are multiple functions with the
same name. For example, fft (comm) corresponds to the fft function in the Communications
Toolbox™ folder.
4 Select a function that you would like to use or learn more about, as follows.
• Insert the function name into the current window by double-clicking the name. Alternatively,
drag and drop the function name into any tool or application.
• View syntax information for the function by single-clicking its name. A brief description for
each of the syntax options displays in a yellow pop-up window.
Tip The pop-up window automatically closes when you move your pointer to a new item in the
results list. To keep the pop-up window open, drag it by the top edge to a different location.
You can change the font that the Function browser uses by setting preferences. On the Home tab, in
the Environment section, select Preferences > Fonts. By default, the Function browser uses the
desktop text font and the pop-up window uses the Profiler font.
3-5
3 Entering Commands
Format Output
MATLAB displays output in both the Command Window and the Live Editor. You can format the
output display using several provided options.
x =
1.3333 0.0000
• compact — Suppresses the display of blank lines.
• On the Home tab, in the Environment section, click Preferences. Select MATLAB >
Command Window, and then choose a Line spacing option.
• Use the format function at the command line, for example:
format loose
format compact
For example, suppose that you enter x = [4/3 1.2345e-6] in the Command Window. The MATLAB
output display depends on the format you selected. This table shows some of the available numeric
display formats, and their corresponding output.
3-6
Format Output
Note The text display format affects only how numbers are shown, not how MATLAB computes, or
saves them.
• On the Home tab, in the Environment section, click Preferences. Select MATLAB >
Command Window, and then choose a Numeric format option.
• Use the format function, for example:
format short
format short e
format long
See the format reference page for a list and description of all supported numeric formats.
1 On the Home tab, in the Environment section, click Preferences. Select MATLAB >
Command Window.
2 Select Wrap Lines.
3 Click OK.
Suppress Output
To suppress code output, add a semicolon (;) to the end of a command. This is useful when code
generates large matrices.
Running the following code creates A, but does not show the resulting matrix in the Command
Window or the Live Editor:
A = magic(100);
Output in the Command Window might exceed the visible portion of the window. You can view the
output, one screen at a time:
3-7
3 Entering Commands
• On the Home tab, in the Code section, select Clear Commands > Command Window to clear
the Command Window scroll buffer.
• Use the clc function to clear the Command Window scroll buffer.
• Use the home function to clear your current view of the Command Window, without clearing the
scroll buffer.
See Also
clc | format | home | more
3-8
Stop Execution
Stop Execution
To stop execution of a MATLAB command, press Ctrl+C or Ctrl+Break.
On Apple Macintosh platforms, you also can use Command+. (the Command key and the period
key).
Ctrl+C does not always stop execution for files that run a long time, or that call built-ins or MEX-files
that run a long time. If you experience this problem, include a drawnow, pause, or getframe
function in your file, for example, within a large loop. Also, Ctrl+C might be less responsive if you
start MATLAB with the -nodesktop option.
Note For certain operations, stopping the program might generate errors in the Command Window.
To programmatically stop execution of a function or script before reaching the end, use the return
function. MATLAB returns control to the Command Window or the invoking function.
See Also
drawnow | getframe | pause | return
3-9
3 Entering Commands
To search for specified text in the Command Window, on the Command Window title bar, click the
action button , and then select Find. The Find dialog box opens. The search begins at the current
cursor position. MATLAB finds the text you specified and highlights it.
MATLAB beeps when a search for Find Next reaches the end of the Command Window, or when a
search for Find Previous reaches the top of the Command Window. If you have Wrap around
selected, MATLAB continues searching after beeping.
To search for the specified text in other MATLAB desktop tools, change the selection in the Look in
field.
You can increase the amount of information available in the Command Window so that more text is
available for searching. Doing so requires more memory. On the Home tab, in the Environment
section, click Preferences. Select MATLAB > Command Window, and then increase the setting
for Number of lines in the command window scroll buffer.
Clearing the command window (for example, with the clc function), empties the scroll buffer. The
cleared text is no longer available for searching. To clear your display in the Command Window
without clearing the buffer, use the home function.
You can also perform an incremental search in the Command Window using keyboard shortcuts.
An incremental search field appears in the bottom right corner of the MATLAB Desktop window.
For a forward search, the text F Inc Search appears. The F indicates a forward search.
3-10
Find Text in Command Window or History
When you enter lowercase letters in the incremental search field, MATLAB looks for both
lowercase and uppercase instances of the letters. For example, if you enter b, MATLAB looks for
b and B. However, if you enter uppercase letters, MATLAB only looks for instances that match the
case you entered.
3 Perform incremental search actions using these keyboard shortcuts:
If you search for a set of characters that does not appear in the Command Window text, Failing
appears in the incremental search field.
4 End incremental searching by pressing Esc (escape), Enter, or any other key that is not a
character or number.
The incremental search field disappears. The cursor remains at the position where the text was
last found, with the search text highlighted.
1 In the Command History window, type in the Search field. To display the Search field if it is not
visible, click the action button , and then select Find.
The Command History window searches backward and selects the previous entry that contains
the sequence of letters you typed.
3 Select from the different search options using the buttons to the right of the search field. Options
include Match case
, Match anywhere
within command ,
and Match at beginning of command
.
4 Find the previous or next occurrence of the entry with the up and down arrow keys, respectively.
5 Press Esc to clear the search.
In MATLAB Online, to search for text in the Command History window, click the Command History
icon in the sidebar and use the Search field to perform a search.
3-11
3 Entering Commands
See Also
Command Window | Command History
Related Examples
• “Find and Replace Text in Files and Go to Location”
• “Find Files” on page 6-2
3-12
Rerun Favorite Commands
MATLAB favorite commands (previously called command shortcuts) are an easy way to run a group of
MATLAB language statements that you use regularly. For example, you can use a favorite command to
set up your environment when you start working, or to set the same properties for figures you create.
1 On the Home tab, in the Code section, click Favorites and then click New Favorite. The
Favorite Command Editor dialog box opens.
2 In the Label field, enter a name for the favorite command. For this example, enter Setup
Workspace.
3 In the Code field, type the statements you want the favorite command to run. You also can drag
and drop statements from the Command Window, the Command History Window, or a file.
MATLAB automatically removes any command prompts (>>) from the Code field when you save
the favorite command. When navigating using the keyboard, use Esc to move out of the Code
field.
format compact
clear
workspace
filebrowser
clc
4 In the Category field, type the name of a new category or select an existing category from the
drop-down list. If you leave this field blank, the favorite command appears in the default
Favorite Commands category.
5 In the Icon field, select an icon.
6 To add the favorite command to the quick access toolbar, select both the Add to quick access
toolbar and Show label on quick access toolbar options.
7 To run the statements in the Code section and ensure that they perform the desired actions, click
Test.
8 When you are done configuring the favorite command, click Save.
To run a favorite command, on the Home tab, click Favorites and then click the icon for the desired
favorite command. All the statements in the Code field of the Favorite Command Editor execute as if
you ran those statements from the Command Window, although they do not appear in the Command
History window.
To edit a favorite command, click the Edit favorite command button to the right of the favorite
command. To delete a favorite command, click the Delete favorite command button to the right of
the favorite command. You also can right-click the favorite command and select Edit Favorite or
Delete Favorite.
3-13
3 Entering Commands
You can organize your favorite commands by storing them in different categories.
1 On the Home tab, in the Code section, click Favorites and then click New Category. The
Favorite Category Editor dialog box opens.
2 In the Label field, enter a name for the category. For this example, enter My Favorite
Favorites.
3 In the Icon field, select an icon.
4 To add the category to the quick access toolbar, select both the Add to quick access toolbar
and Show label on quick access toolbar options.
5 Click Save.
To move a category up or down in the list of categories, or to move a favorite command within a
category, drag the category or favorite command to the desired location. You also can use the Move
category to top and Move category to bottom buttons to the right of the category.
To change whether a single category or favorite command appears in the quick access bar, click the
Add to quick access toolbar and Remove from quick access toolbar buttons to the right of the
category or favorite command. In MATLAB Online, right-click the category or command and select
Add to quick access toolbar. To add all favorite commands to the quick access bar, on the
Home tab, right-click Favorites and select Add to quick access toolbar.
To further configure which favorite commands and categories appear in the quick access bar, on the
Home tab, in the Code section, click Favorites and then click Quick Access. Configuring the
quick access bar is not supported in MATLAB Online.
See Also
More About
• “Customize Keyboard Shortcuts” on page 2-45
• “Set Command History Preferences” on page 3-24
3-14
Set Command Window Preferences
You can customize the visual display and behavior of the Command Window and the command output
within it using Command Window preferences.
On the Home tab, in the Environment section, click Preferences. Select MATLAB > Command
Window, and then adjust the options as described in this table.
Preference Usage
Text display Select a Numeric format option to specify the output format of numeric
values in the Command Window.
For details, see “Wrap Lines of Code to Fit Window Width” on page 3-7.
Select Set matrix display width to eighty columns to limit the width of
matrix output.
If you also select Wrap lines, and the width of the Command Window is fewer
than 80 characters, each row of 80 characters of matrix output wraps to fit
within the width of the Command Window.
Select Show getting started message bar to display the Command Window
message bar that provides links to introductory information.
3-15
3 Entering Commands
Preference Usage
Select Show function browser button to display the Browser for functions
button to the left of the prompt in the Command Window. You can use the
Function browser to search for MATLAB functions.
Select Suggest corrections for mistyped functions and variables to
display suggestions in the Command Window. If you enter an undefined
function, variable name, or MATLAB operator, MATLAB displays:
followed by a suggested command at the command line. You can press Enter
to execute that command or Esc to delete the suggestion.
Number of lines in command window scroll buffer specifies the maximum
number of lines displayed in the Command Window. A larger scroll buffer
provides a larger base for search features, but requires more memory. By
default, the scroll buffer is set to 5,000 lines.
The scroll buffer size does not impact the number of lines that you can recall.
By default, you can use the up arrow key ↑ to recall all lines shown in the
Command History window, regardless of how many lines you see in the
Command Window.
Tab key Tab size specifies the number of spaces assigned to the tab key.
This setting does not apply if you have enabled tab completion for the
Command Window or Editor. To enable or disable tab completion, on the
Home tab, select Preferences > Keyboard.
You can change how MATLAB suggests and completes names in the Command Window.
On the Home tab, in the Environment section, click Preferences. Select MATLAB > Command
Window > Automatic Completions, and then adjust the options as described in this table.
Preference Usage
Suggestions and completions Select Enable tab completion to suggest names when you type the first few
characters of the name and press the Tab key in the Command Window.
For more information, see “Check Syntax and Autocomplete Code as You
Type” on page 3-19.
Select Tab key narrows completions to continue to reduce the list of
suggestions as you type each additional character and press the Tab key.
For more information, see “Check Syntax and Autocomplete Code as You
Type” on page 3-19.
3-16
Set Command Window Preferences
Preference Usage
Select Enable function hints to display function syntax suggestions in the
Command Window.
When enabled, if you type a function name with an opening parenthesis, and
then pause, a tooltip opens showing the basic syntax information for the
function.
For more information, see “Check Syntax and Autocomplete Code as You
Type” on page 3-19.
In MATLAB Online, to show suggestions as you type in the Command Window, select Show
suggestions automatically. To show suggestions when you press the Tab key, select Use tab to
show suggestions (in addition to ctrl+space). To accept suggestions using the Right Arrow key,
select Use right arrow to accept suggestions (in addition to tab and enter). To reset the
window that displays the list of suggestions to it's original size, click the Reset Default Suggestion
Size button.
See Also
More About
• “Check Syntax and Autocomplete Code as You Type” on page 3-19
• “Set Keyboard Preferences” on page 3-18
• “Zoom and Change Desktop Fonts” on page 2-2
3-17
3 Entering Commands
You can set delimiter matching options in the Command Window, Editor, and Live Editor.
On the Home tab, in the Environment section, click Preferences. Select MATLAB > Keyboard,
and then adjust the options as described in this table.
Preference Usage
Delimiter Matching Specify when and if MATLAB alerts you to matched and mismatched
delimiters. Delimiters include parentheses, brackets, braces, and, in the
Editor only, paired keywords.
Select Show matches and mismatches when typing for MATLAB to alert
you to matched and mismatched delimiters as you type.
Select Show matches and mismatches when using arrow keys for
MATLAB to alert you to matched and mismatched delimiters when you move
the cursor over a delimiter by using an arrow key.
See Also
Related Examples
• “Check Syntax and Autocomplete Code as You Type” on page 3-19
• “Set Command Window Preferences” on page 3-15
3-18
Check Syntax and Autocomplete Code as You Type
Syntax Highlighting
To help you identify MATLAB elements, some entries appear in different colors in the Command
Window, the Editor, and the Live Editor. This color display is known as syntax highlighting. By default:
Except for errors, output in the Command Window does not appear with syntax highlighting.
MATLAB software copies the selection to the clipboard in RTF format, which many Microsoft
Windows and macOS applications support. When you paste or drag a selection from the Editor and
Live Editor to another application, such as Microsoft Word, the pasted text maintains the syntax
highlighting colors and font characteristics from the Editor and Live Editor.
To change syntax highlighting preferences, on the Home tab, in the Environment section, click
Preferences. Then, select MATLAB > Editor/Debugger > Language and from the Language
drop-down list, choose a language. To change syntax highlighting preferences in MATLAB Online,
select Editor/Debugger > MATLAB Language or Editor/Debugger > Other Languages.
Delimiter Matching
MATLAB indicates matched and mismatched delimiters, such as parentheses, brackets, and braces, to
help you avoid syntax errors. MATLAB also indicates paired language keywords, such as for, if,
while, else, and end statements.
In the Editor and Live Editor, MATLAB indicates matching delimiters by briefly underlining both
delimiters in the pair. In the Command Window, matching delimiters are indicated by highlighting
instead of underlining. In MATLAB Online, the Command Window behavior matches the Editor and
Live Editor behavior.
MATLAB indicates mismatching delimiters in the Editor, Live Editor, and Command Window by briefly
crossing out the mismatched delimiter.
If a matching delimiter exists, but it is not visible on the screen, a window opens and displays the line
containing the matching delimiter. Click in the window to go to that line.
3-19
3 Entering Commands
You can change if and when MATLAB alerts you to matched and mismatched delimiters. On the
Home tab, in the Environment section, click Preferences. Select MATLAB > Keyboard and in
the Delimiter matching section, select from the available options.
When you write code in the Command Window, Editor, Live Editor, and App Designer, MATLAB shows
suggestions for the names of functions, models, MATLAB objects, files, folders, variables, structures,
graphics properties, parameters, and options. In addition, MATLAB shows basic syntax information
for functions. You can use these suggestions to write commands faster and avoid typographical
errors.
Name Suggestions
In the Editor, Live Editor, and App Designer, name suggestions appear as you type. You also can press
Ctrl+Space or the Tab key to show suggestions. MATLAB shows the most relevant name suggestions
as you type. To show new and more refined suggestions, continue typing. If there are no name
suggestions, MATLAB displays No suggestions.
To insert a suggestion in your code, use the arrow keys to select the name that you want, and then
press the Right Arrow, Tab, or Enter key to accept the suggestion. To clear the list of suggestions
without selecting anything, press the Esc key.
In the Command Window, name suggestions appear only after you press the Tab key. To show
suggestions, type the first few characters of the name that you want suggestions for, and then press
the Tab key. Use the arrow keys to select the name that you want, and then press the Tab key again
to accept the suggestion. In MATLAB Online, the Command Window also shows suggestions as you
type and when you press Ctrl+Space or the Tab key.
Name suggestions are useful when completing the names and values of graphics properties. For
example, plot(x,y,"LineStyle","-").
3-20
Check Syntax and Autocomplete Code as You Type
You also can use suggestions to complete parameter names and options for certain functions. For
example, format("shortEng").
MATLAB does not complete field names of structure arrays defined only within the active document.
Tip To insert a tab within a statement when suggestions and completions are enabled in the Editor,
Live Editor, and App Designer, first, add a space. Then, press the Tab key. Alternatively, go to the
Home tab, and in the Environment section, click Preferences. Select MATLAB > Editor/
Debugger > Automatic Completions and in the Suggestions and completions section, clear the
Use tab to show suggestions (in addition to ctrl+space) option. If there are no available
completions, MATLAB always inserts a tab.
In the Command Window, to insert a tab, you must disable showing name suggestions on tab. To
disable showing name suggestions, in the Preferences window, select MATLAB > Command
Window > Automatic Completions and clear the Enable tab completion option. In the MATLAB
Online Command Window, clear the Use tab to show suggestions (in addition to ctrl+space)
option.
3-21
3 Entering Commands
When you type the name of a function followed by an opening parenthesis, MATLAB shows the basic
syntax information for the function. In the Editor, Live Editor, App Designer, and MATLAB Online
Command Window, if a function has multiple syntaxes, you can use the drop-down arrow to the right
of the syntax to show all available syntaxes. Alternatively, use Ctrl+Down Arrow to show and hide
the additional syntaxes. On macOS systems, use the Command key instead of Ctrl.
You can type an input for any argument that appears in blue. Enter your own input variables or
values, and not the argument names shown in the suggestion. The displayed syntax options change
based on the arguments you enter.
In the Editor, Live Editor, App Designer, and MATLAB Online Command Window, MATLAB shows
descriptions for each argument. Optional arguments are indicated by the (Optional) keyword next to
the argument description. If MATLAB suggests multiple arguments, click the arrow to the right of the
argument description to view the additional arguments. Alternatively, you can use the Ctrl+Alt
+Right Arrow and Ctrl+Alt+Left Arrow keyboard shortcuts.
To open the documentation for the function MATLAB is showing syntax suggestions for, click the Help
button to the left of the function syntax suggestions, or, in the Command Window, click the More
Help... link below the function syntax suggestions.
Suggestions for function syntaxes and arguments appear for MATLAB installed functions and for
functions that you create. The suggestions for MATLAB functions come from the documentation. The
suggestions for functions that you create come from the function definition statement (first
executable line) in the MATLAB program file. That file must be on the search path or in the current
folder. For more information about adding help to the functions that you create, see “Add Help for
Your Program” and “Customize Code Suggestions and Completions”.
In the Editor, Live Editor, and App Designer, you can disable showing suggestions automatically. You
also can disable the use of the Tab key for showing suggestions and the use of the Right Arrow key
for accepting suggestions. To disable these options, go to the Home tab, and in the Environment
3-22
Check Syntax and Autocomplete Code as You Type
section, click Preferences. Select MATLAB > Editor/Debugger > Automatic Completions
and in the Suggestions and completions section, clear one or more of the options:
• To disable showing suggestions automatically, clear the Show suggestions automatically option.
• To disable showing suggestions after you press the Tab key, clear the Use tab to show
suggestions (in addition to ctrl+space) option. When this option is cleared, you can still show
suggestions by pressing Ctrl+Space.
• To disable accepting a suggestion using the Right Arrow key, clear the Use right arrow to
accept suggestions (in addition to tab and enter) option. When this option is cleared, you can
still accept a suggestion using the Tab and Enter keys.
In the Command Window, you can disable showing name suggestions and function syntax
suggestions. To disable showing name suggestions, in the Preferences window, select MATLAB >
Command Window > Automatic Completions and clear the Enable tab completion option. To
disable showing function syntax suggestions, clear the Enable function hints option. To disable
reducing the list of suggestions as you type each additional character and press the Tab key, clear the
Tab key narrows completions option.
In MATLAB Online, the Command Window behavior matches the Editor, Live Editor, and App
Designer behavior. To disable showing suggestions automatically, using the Tab key for showing
suggestions, and using the Right Arrow key for accepting suggestions, in the Preferences window,
select MATLAB > Command Window > Automatic Completions. Then, in the Suggestions and
completions section, clear one or more of the options.
See Also
Related Examples
• “Enter Statements in Command Window” on page 3-2
• “Set Command Window Preferences” on page 3-15
3-23
3 Entering Commands
You can exclude statements from the command history and specify how many commands to save to
the command history file, History.xml. MATLAB uses the command history file for both the
Command History window and statement recall in the Command Window.
Note When you exclude statements from the command history file, you cannot recall them in the
Command Window, nor can you view them in the Command History window.
You can also change the way you search for previously executed statements in the command history.
Select from different search text matching options and change the way results are displayed in the
Command History window.
To set Command History preferences, on the Home tab, in the Environment section, click
Preferences. Select MATLAB > Command History, and then adjust the options as described in the
following table.
Option Usage
Save Select Save exit/quit commands to save exit and quit
commands in the command history.
Select Save consecutive duplicate commands to save
consecutive executions of the same statement in the command
history.
Any entries predating the current session remain unless you first
delete entries from the Command History window.
Save last n commands specifies the number of commands to save.
Match Select Match anywhere to retrieve statements that contain the
search text in any location.
3-24
Set Command History Preferences
Option Usage
Select Filter matches to display only statements that match the
search text. Clear Filter matches to display all previously executed
statements and highlight the statements that match the search text.
Show Select Show match toolbar to display a search toolbar at the top of
the Command History window. Search for previously executed
statements using the search field and change Match preferences
using the provided buttons.
Select Show match locations to display yellow markers to the
right of the scroll bar in the Command History window that indicate
the location of matches throughout the command history.
Select Show execution time to display an approximate execution
time to the right of each statement. Times display for any
statements that take longer than 0.1 seconds to execute.
Favorite Commands Select Don't show to disable showing favorite commands in the
Command History window.
1 Change the short date format for your operating system as described in its documentation.
2 Restart MATLAB.
Note Clearing the command history deletes all entries from the Command History window. You
can no longer recall those entries in the Command Window.
See Also
Command History
3-25
4
Each MATLAB function has supporting documentation that includes examples and describes the
function inputs, outputs, and calling syntax. This table describes ways to access that documentation.
— or—
When you open a page from the search results, the keywords that you searched for appear
highlighted. To clear the highlighting, press the Esc key. To filter the search results, use the facets
that appear on the left side of the page.
For example, view MATLAB topics by selecting MATLAB and Help Topics.
4-2
Ways to Get Function Help
See Also
doc
More About
• “MATLAB Code Examples” on page 4-4
4-3
4 Help and Product Information
For instance, to view examples demonstrating plotting in MATLAB, navigate to the MATLAB >
Graphics > 2-D and 3-D Plots category and click Examples at the top of the page.
Additional examples, created by members of the MATLAB community, are available at the File
Exchange.
You also can open some examples directly in your web browser in MATLAB Online by clicking the Try
This Example button (if you are not logged into a MathWorks account) or the Open in MATLAB
Online button (if you are logged into a MathWorks account).
4-4
MATLAB Code Examples
See Also
demo | echodemo | openExample
Related Examples
• “Create and Run Sections in Code”
External Websites
• File Exchange
4-5
4 Help and Product Information
If you are using a MathWorks product and experience technical issues, you can contact MathWorks
technical support to report a bug or request help. Access to technical support requires a valid license
number and a Software Maintenance Service subscription.
To contact technical support directly from MATLAB, follow these steps. This method requires an
internet connection.
1
On the Home tab, in the Resources section, click Request Support.
2 When requested, sign in using your MathWorks Account email address and password. If you do
not have a MathWorks Account, create one.
3 In the Summary and Description fields. provide information to help technical support
reproduce your issue, such as a description of the steps you followed or a code excerpt.
Optionally, you can attach up to five files to your request, where each file is no larger than 5 MB.
4 In the Product field, specify the product that is related to the issue.
5 Press the Submit button to submit the request.
Alternatively, you can request support on the MathWorks Contact Support page. In MATLAB Online
and for certain license types, the Request Support button opens the MathWorks Contact Support
page instead of the Submit a MathWorks Support Request dialog box.
4-6
Contact Technical Support
There are also many resources available on the MathWorks Help Center page. These resources
include documentation for MathWorks products, MATLAB Answers, and installation help.
See Also
More About
• MathWorks Help Center Page
4-7
4 Help and Product Information
Help Preferences
You can customize how MATLAB displays documentation using Help preferences, including whether
to open web or locally installed documentation and, on some non-English systems, what language to
display the documentation in.
To open the Help preferences, on the Home tab, in the Environment section, click Preferences.
Select MATLAB > Help and adjust the preference options as described in the table below.
Preference Usage
Documentation Location Specify whether to view the documentation on the web at https://
www.mathworks.com/help (recommended) or the documentation
installed locally on your system. Viewing the web documentation requires
an internet connection.
4-8
Help Preferences
Preference Usage
Language (selected non-English Specify whether the installed documentation and the documentation in
systems only) other help windows appears in your system language or in English. This
option is available for selected non-English systems only.
For more information, including how to change the language for the
documentation that opens in your system web browser, see “Translated
Documentation” on page 4-10.
To adjust the font size of the documentation, adjust the zoom settings for your system web browser.
See Also
More About
• “Install Documentation”
• “Translated Documentation” on page 4-10
4-9
4 Help and Product Information
Translated Documentation
Many MathWorks products have translated documentation in Japanese. In addition, some features of
MATLAB have translated documentation in Korean, simplified Chinese, Spanish, French, Italian, and
German. If you install documentation locally, a product with translated documentation usually installs
the translated documentation from the previous version and the English documentation for the
current version.
For information about documentation in other languages, contact your MathWorks Sales and Service
office.
Use the Language option in the MATLAB Help preferences to change the documentation language in
the Help browser. Supported languages include English, Japanese, Korean, Chinese, Spanish, French,
Italian, or German. For more information, see “Help Preferences” on page 4-8.
Note
• The Language preference appears only when your system language is set to Japanese, Korean,
Chinese.
4-10
Translated Documentation
• The Language preference changes only the documentation language in the installed
documentation and other help windows. To change the language of the text in the MATLAB
desktop, see “Change the MATLAB Desktop Language” on page 9-9.
See Also
Related Examples
• “Change the MATLAB Desktop Language” on page 9-9
• “Help Preferences” on page 4-8
• “Set Locale and Display Language” on page 9-2
4-11
4 Help and Product Information
4-12
5
Create Variables
The MATLAB workspace consists of the variables you create and store in memory during a MATLAB
session. You can create new variables in the workspace by running MATLAB code or using existing
variables.
To create a new variable, enter the variable name in the Command Window, followed by an equal sign
(=) and the value you want to assign to the variable. For example, if you run these statements,
MATLAB adds the four variables x, A, I, and C to the workspace:
x = 5.71;
A = [1 2 3; 4 5 6; 7 8 9];
I = besseli(x,A);
C = {A A A};
If you do not end the assignment statement with a semicolon (;), MATLAB displays the result in the
Command Window. For example,
x = 5.71
x =
5.7100
If you do not explicitly assign the output of a statement to a variable, MATLAB generally assigns the
result to the reserved word ans. The value of ans changes with every statement that returns an
output value that is not assigned to a variable. For example,
sin(1)
ans =
0.8415
To view and edit variables, use the Workspace browser and Variables editor. (Some editing options
are not available in MATLAB Online.)
5-2
Create and Edit Variables
To open the Workspace browser if it is not currently visible, do either of the following:
• On the Home tab, in the Environment section, click Layout. Then, under Show, select
Workspace.
• Type workspace in the Command Window.
By default, the Workspace browser displays the base workspace. You also can view function
workspaces if MATLAB is in debug mode. For more information, see “Base and Function
Workspaces”.
To display additional columns such as size and range, on the Workspace browser title bar, click the
Show Workspace Actions button , and then click Choose Columns. In MATLAB Online, to select
which columns to display, right-click a column name in the Workspace panel and select or clear the
desired column names.
You also can use the who command in the Command Window to view a list of variables. To list
information about size and class, use the whos command. For example, if you have the variables x, A,
and I in your workspace, you can run the who and whos commands to view your workspace contents:
who
A C I x
whos
A 3x3 72 double
C 1x3 528 cell
I 3x3 72 double
x 1x1 8 double
• Command Window — Type the variable name at the command prompt. For example:
x =
5.7100
• Variables editor — In the Workspace browser, double-click a variable name. The Variables editor
opens for that variable.
5-3
5 Workspace Browser and Variable Editor
Some variables open a viewer or other tool appropriate for their type. For details, see the
documentation for that data or object type.
To change how the Variables editor displays variables, go to the View tab, and in the Format
section, select a number display format. The display format does not affect how values are
displayed in the Command Window or Workspace browser, or how the variables are saved.
Note The maximum number of elements in a variable that you can open in the Variables editor
depends on your operating system and the amount of physical memory installed on your system.
To edit other variables, open them in the Variables editor. For example, suppose that you create a cell
array, C, by running these commands in the Command Window:
A = magic(4);
C = {A A A};
In the Workspace browser, double-click the variable name C to open it in the Variables editor.
5-4
Create and Edit Variables
To edit an element of a variable, double-click the element. The element opens in a new document
within the Variables editor. For example, if you double-click element C{1,1} in the Variables editor,
the contents of that cell open in a new tab. You can edit the value of a variable element by clicking
the element and typing a new value. Press Enter or click another element to save the change.
To return to the parent cell array or structure of an element, go to the View tab and click the Go Up
button.
Changes you make in the Variables editor are automatically saved in the workspace. Changes you
make to variables via the Command Window or other operations automatically update the information
for those variables in the Workspace browser and Variables editor.
Note
• You cannot edit elements or subsets of multidimensional arrays in the Variables editor.
• You cannot edit tall arrays in the Variables editor.
• When editing strings in the Workspace browser or as part of a structure in the Variables editor,
you must use double quotes to surround the string value.
Tables (including timetables) and structure arrays support additional editing actions.
5-5
5 Workspace Browser and Variable Editor
Action Procedure
Modify column or row name Double-click the name and enter the new text.
Reorder variables Hover over the left side of a variable until a four-headed arrow
appears. Then, click and drag the column to a new location.
Modify units and description of Click the arrow that appears to the right of a variable name. Then,
variables enter new text in the Units and Description fields.
5-6
Create and Edit Variables
Action Procedure
Sort variable data Click the arrow that appears to the right of a variable name and
select Ascending or Descending.
Note The contents of a table are only visible and modifiable when the number of variables is fewer
than 5000. When the number of variables equals or exceeds 5000, you can only view the table
properties.
Changes made to certain variable types in the Variables editor also appear in the Command Window.
For example, suppose you have a table T that contains three columns, A, B, and C. If you delete
column A in the Variables editor, the line T(:,'A') = []; displays in the Command Window. To
suppress code display in the Command Window, on the View tab, clear the Show MATLAB Code
check box.
Action Procedure
Delete row, column, or variable Right-click the desired row header, column header, or selected
elements elements and select Delete Row or Delete Column.
Insert new row or column Right-click the desired row header, column header, or element and
select Insert Row Above, Insert Row Below, Insert Column to
the Left, or Insert Column to the Right. You can also add rows
or columns simply by entering a value in an empty row or column.
For example, to add a row and column to the array in C{1,1},
enter a value in element (5,5).
Cut variable elements Right-click the desired row header, column header, or selected
elements and select Cut. The cut values move to the clipboard and
are replaced by the default value for empty elements. For more
information, see “Empty Elements” on page 5-8.
5-7
5 Workspace Browser and Variable Editor
Action Procedure
Copy variable elements Right-click the desired row header, column header, or selected
elements and select Copy.
Paste variable elements Right-click the row header, column header, or element where you
want the insertion to begin and select Paste.
Paste cells from Microsoft Excel Right-click the element where you want the insertion to begin, and
spreadsheet then select Paste Excel Data.
Empty Elements
Empty elements in variables are assigned default values. Default assignments are:
Action Procedure
Copy variable to and from Select the variables, right-click, and then select Copy. Then, you
clipboard can paste the names, for example, into the Command Window or
an external application. Multiple variables are comma-separated.
Duplicate variable Select the variables, right-click, and then select Duplicate.
MATLAB creates a copy of the selected variables.
Rename a workspace variable Right-click the variable name, and then select Rename. Type the
new variable name and press Enter.
Delete all variables in On the Home tab, in the Variable section, click Clear
workspace Workspace.
You also can use the clear function in the Command Window.
Delete selected variables from Select the variables in the Workspace browser, right-click, and
workspace then select Delete.
You can also use the clear function in the Command Window. For
example, to clear variables A and B, use the command clear A B.
To create a new workspace variable from an existing variable, in the Variables editor, select an
element, data range, row, or column in an array, and then in the Variable tab, select New from
Selection.
You can change the character that delimits decimals in the data when you cut and paste values from
the Variables editor into text files or other applications. You might do this, for instance, if you provide
5-8
Create and Edit Variables
data to a locale that uses a character other than the period (.). To change the delimiter character,
specify a Decimal separator for exporting numeric data via system clipboard in the “Variables
Preferences” on page 5-15.
Within a selection, Tab also moves from the last column in one row
to the first column in the next row.
Move in opposite direction of Enter or Tab. Shift+Enter or Shift+Tab
Move up m rows, where m is the number of visible rows. Page Up
Move down m rows, where m is the number of visible rows. Page Down
Move to column 1. Home
Move to row 1, column 1. Ctrl+Home
Edit current element, positioning cursor at the end of the element. F2 (Ctrl+U on Apple Macintosh
platforms)
See Also
openvar | Workspace Browser
More About
• “Variable Names”
• “Display Statistics in the Workspace Browser” on page 5-10
• “Workspace and Variable Preferences” on page 5-14
• “Save and Load Workspace Variables” on page 5-12
5-9
5 Workspace Browser and Variable Editor
To display statistics, on the Workspace browser title bar, click the Show Workspace Actions
button, and then select Choose Columns. Select the statistics you want MATLAB to calculate. In
MATLAB Online, to select which columns to display, right-click a column name in the Workspace
panel and select or clear the desired column names.
On the Workspace browser title bar, click the Show Workspace Actions button, and then
select Choose Columns. Clear the statistics that you do not want MATLAB to calculate. In
MATLAB Online, to change which statistics display, right-click a column name in the Workspace
panel and clear the statistics that you do not want MATLAB to calculate.
• Exclude large arrays from statistical calculations.
On the Home tab, in the Environment section, click the Specify preferences button. Select
MATLAB > Workspace, and then use the arrow buttons under Statistical calculations to
change the maximum array size for which the Workspace browser performs statistical
calculations. Any variable exceeding the maximum array size reports <Too many elements> in
Workspace browser statistics columns instead of statistical results.
If a variable includes a NaN, and you select this option, the values for Min, Max, Var, and several
other statistics appear as NaN. However, Mode and several other statistics show a numeric result.
• Ignore NaNs whenever possible
If a variable includes a NaN, and you select this option, numeric results appear for most statistics
including Min, Max, and Mode. However, Var still appears as NaN.
5-10
Display Statistics in the Workspace Browser
See Also
More About
• “Infinity and NaN”
• “Workspace and Variable Preferences” on page 5-14
5-11
5 Workspace Browser and Variable Editor
The workspace is not maintained across sessions of MATLAB. When you quit MATLAB, the workspace
clears. However, you can save any or all the variables in the current workspace to a MAT-file (.mat).
You can then reuse the workspace variables later during the current MATLAB session or during
another session by loading the saved MAT-file.
• To save all workspace variables to a MAT-file, on the Home tab, in the Variable section, click
Save Workspace.
• To save a subset of your workspace variables to a MAT-file, select the variables in the Workspace
browser, right-click, and then select Save As. You also can drag the selected variables from the
Workspace browser to the Current Folder browser.
• To save variables to a MATLAB script, click the Save Workspace button or select the Save As
option, and in the Save As window, set the Save as type option to MATLAB Script. Variables
that cannot be saved to a script are saved to a MAT-file with the same name as that of the script.
You also can save workspace variables programmatically using the save function. For example, to
save all current workspace variables to the file june10.mat, use the command
save('june10')
To save only variables A and B to the file june10.mat, use the command
save('june10','A','B')
To store fields of a scalar structure as individual variables, use the save function with the -struct
option. This can be useful if you previously loaded variables from a MAT-File into a structure using
the syntax S = load(filename) and want to keep the original variable structure when saving to a
new MAT-File.
To save part of a variable, use the matfile function. This can be useful if you are working with very
large data sets that are otherwise too large to fit in memory. For more information, see “Save and
Load Parts of Variables in MAT-Files”.
In MATLAB Online, variables persist between sessions. Saving allows you to clear the workspace and
load variables at a later time. To save variables, use the save or matfile functions.
To load a subset of variables from a MAT-file on the Home tab, in the Variable section, click Import
Data. Select the MAT-file you want to load and click Open. You also can drag the desired variables
from the Current Folder browser Details panel of the selected MAT-file to the Workspace browser. In
MATLAB Online, you also can click the Preview button to the right of the MAT-file in the Files
browser and drag the desired variables from the preview to the Workspace panel.
5-12
Save and Load Workspace Variables
To load variables saved to a MATLAB script into the workspace, simply run the script.
You also can load saved variables programmatically, use the load function. For example, load all
variables from the file durer.mat
load('durer')
load('durer','X','map')
To load part of a variable, use the matfile function. This is useful if you are working with very large
data sets that are otherwise too large to fit in memory. For more information, see “Save and Load
Parts of Variables in MAT-Files”.
Caution When you load data into the MATLAB workspace, the new variables you create overwrite
any existing variables in the workspace that have the same name. To avoid overwriting existing
variables, use the load function to load the variables into a structure. For example, S =
load('durer') loads all the variables from the file durer.mat into the structure S.
Alternatively, use the command whos -file filename. This function returns the name, dimensions,
size, and class of all variables in the specified MAT-file. For example, you can view the contents of the
example file durer.mat.
The byte counts represent the number of bytes that the data occupies in memory when loaded into
the MATLAB workspace. Because of compression, data encoding, and metadata, the space occupied
in the file by a variable may be different from the in-memory size. MATLAB compresses data in
Version 7 or higher MAT-files. For more information, see “MAT-File Versions”.
See Also
save | load
More About
• “MAT-File Versions”
• “Save and Load Parts of Variables in MAT-Files”
5-13
5 Workspace Browser and Variable Editor
In this section...
“Workspace Preferences” on page 5-14
“Variables Preferences” on page 5-15
Workspace Preferences
Workspace preferences enable you to configure options for saving workspace variables to MATLAB
scripts. They also enable you to restrict the size of arrays on which MATLAB performs calculations,
and to specify if you want those calculations to include or ignore NaNs.
To open Workspace preferences, on the Home tab, in the Environment section, click
Preferences. Select MATLAB > Workspace.
Preference Usage
Threshold for saving variables to MATLAB Specify Maximum array size to limit the
script number of elements of arrays saved to a MATLAB
script.
Specify Maximum struct/object nesting levels
to limit the nesting level of structures, arrays, or
objects saved to a MATLAB script.
Multidimensional array formatting Specify how multidimensional arrays are
formatted when saved to a MATLAB script.
5-14
Workspace and Variable Preferences
Preference Usage
Specify whether NaN values are included or
excluded from calculations for the statistics
displayed in the Workspace browser.
Variables Preferences
When working in the Variables editor, Variables preferences enable you to specify array formatting,
cursor movement, and the decimal separator for exporting data using the system clipboard.
To open Variables preferences, on the Home tab, in the Environment section, click Preferences.
Select MATLAB > Variables.
Preference Usage
Format Select an option from the Default array format to specify the
default array output format of numeric values displayed in the
Variables editor. This format preference affects only how numbers
display, not how MATLAB computes or saves them. For
information on formatting options, see the reference page for the
format function.
5-15
5 Workspace Browser and Variable Editor
Preference Usage
Editing Specify where the cursor moves to after you type an element and
press Enter.
To keep the cursor in the element where you typed, clear the
Move selection after Enter check box.
Some Variables preferences are not available in MATLAB Online. To show generated code in the
Command Window when performing operations in the MATLAB Online Variables Editor, select Show
MATLAB code for operations.
See Also
More About
• “Create and Edit Variables” on page 5-2
5-16
6
Find Files
In this section...
“Simple Search for File Names” on page 6-2
“Advanced Search for Files” on page 6-2
“Advanced Search in MATLAB Online” on page 6-4
1
Click the search button
in the Current Folder toolbar. The address bar becomes a search field.
2 Type a portion of a file name. The asterisk character (*) is a wildcard. For example, to show only
file names that begin with coll and have a .m extension, type coll*.m.
3 Press Enter.
MATLAB displays all files within the current folder (including its subfolders) that match that file
name. If you typed the full path to a folder, that folder becomes the current folder.
To clear the results and show all items in the current folder, press the Esc key.
In MATLAB Online, to search for files in the current folder or in the current project, go to the Home
tab and click the Go to File button.
To perform an advanced search for files, you can use the Find Files tool. Use the Find Files tool to:
To open the Find Files tool, on the Home tab, in the File section, click Find Files. Enter your
search criteria in the dialog box that opens.
6-2
Find Files
Use the Look in menu to specify the folders you want to search. Select Entire MATLAB Path to
search all folders on the MATLAB search path. Alternatively, you can browse for a folder by selecting
Browse... or you can enter the full path for one or more folders. Separate each path with a semicolon
(;).
Click Find to begin the search. Search results appear in the right pane of the dialog box, with a
summary at the bottom. For text searches, results include the line number and line of code. To see file
locations, select Show full path names.
Open one or more files by right-clicking the files and selecting one of the Open options.
You can search for files with only a specified extension, by selecting an option in the Include only
file type(s) menu. For example, select *.m, *.mlx to limit the search to MATLAB program files.
1 In the Include only file type(s) menu, select All files (*).
2 Under More options, select the Skip file type(s) box and click Edit. The Edit Skipped File
Extensions dialog box opens.
3 Select the State check box for the file types to exclude from your search.
4 Click OK to accept your changes.
You can remove any file extension from the list by selecting the extension to highlight it. Then, click
Remove.
Under More options, you can choose to search file contents for a partial word. From the Search
type menu, select Contains text. To find an exact full-word match, select Matches whole word.
6-3
6 Managing Files in MATLAB
Searching within large files can be time consuming. To speed up your search, specify a file size in the
Skip files over field. The Find Files tool ignores files larger than the size you specify.
Troubleshooting
If the Find Files tool does not find the file you want, try the following:
• When searching for file names, use the asterisk character (*) as a wildcard character to expand
your search. For example, to show file names that begin with coll and have a .m extension, type
coll*.m.
• Select the Include Subfolders check box if the file might be in a subfolder.
• If you select the Skip file type(s) check box, ensure that you do not exclude relevant file types
from your search. Click Edit and review the Edit Skipped File Extensions dialog box. Ensure that
relevant file types do not have the State check box selected.
Files panel. To open the Find Files panel, click the Find Files icon in the sidebar. If the Find Files
icon is not in the left or right sidebar, go to the Home tab, and in the File section, click Find
Files.
To change how the Find Files tool searches for text, select a search option:
• Match case – Search only for text with the precise case of the search text.
• Match whole word – Search only for exact full-word matches.
• Filters – Specify whether to search for file names or file content, what folders to search in, and
what file types to include in the results.
To replace text in filenames and file content, click the expand button to the left of the search field
to open the replace options. Then, to replace an instance of the search text in the results, select the
line containing the result, enter the text that you want to replace the search text with, and click the
Replace button. To replace all instances of the search text, click the Replace All button. Replacing
text is supported in text files (.txt) and MATLAB code files (.m).
6-4
Find Files
After performing a search, you can collapse or clear the list of search results, and export the results
as plain text. To collapse or clear the list of search results, click the Find Files actions button ( ) at
the top of the Find Files panel and select Collapse Results or Clear Results. To export the list of
search results as a plain text file (.txt) that can be viewed in an external text editor, click the Find
Files actions button ( ) and select Export as Plain Text.
See Also
dir | exist | what | which
More About
• “Find Functions to Use” on page 3-4
• “What Is the MATLAB Search Path?” on page 6-47
6-5
6 Managing Files in MATLAB
You can use the Comparison Tool to display the differences between selected pairs of files or folders.
For some file types, you also can merge changes from one file to the other.
Comparison Process
The comparison process involves three steps:
1 Select the files or folders to compare.
2 Choose a comparison type.
3 Explore the comparison report.
You can select files and folders to compare using any of these methods:
• MATLAB desktop — Go to the Home tab, and in the File section, click Compare. Click the
button to select items to compare, or drag and drop files from your file browser into the First file
or folder or Second file or folder fields.
• Current Folder browser — Select a file or folder, right-click, and select Compare Against. Click
the button to select a second item to compare, or drag and drop a file from your file browser
into the Second file or folder field. To select two files or subfolders to compare, Ctrl-click the file
names. Then right-click and select Compare Selected Files/Folders.
• Editor or Live Editor — Go to the Editor or Live Editor tab, and in the File section, click
Compare. The Comparison Tool includes the currently open file in the First file or folder field.
Click the button to select a second item to compare, or drag and drop a file from your file
browser into the Second file or folder field.
To compare a file with the autosave version or the saved version on disk, go to the Editor tab and
click Compare and select Compare with Version on Disk or Save and Compare with
Autosave. If your file is modified, the Editor saves the file before comparing. The Compare with
Version on Disk and Save and Compare with Autosave options are only available if the option
for automatically saving changes to a file is disabled. To disable the option, go to the Home tab,
and in the Environment section, click Preferences. Then, select Editor/Debugger and clear
Save changes upon clicking away from a file. This option is not available in the Live Editor.
• Command Window — Use the visdiff function. For example, to compare the two files
lengthofline.m and lengthofline2.m using the visdiff function and the default text
comparison, type visdiff('lengthofline.m','lengthofline2.m'). MATLAB opens the
Comparison Tool and displays the resulting comparison report.
Tip When selecting folders to compare, select Include subfolders to include subfolder content in
the comparison.
The Comparison Tool compares selected items using the default comparison type defined for the
selected items. For some item types, you can select a different comparison type from the default. For
6-6
Compare Files and Folders and Merge Files
example, you can choose from a text, binary, file list, or XML comparison. To change the comparison
type, select the files or folders to compare. Then, select from the available Comparison type options.
The Comparison Tool displays only the valid options for the selected item types.
You cannot change the comparison type for an existing comparison report. To change the comparison
type, start a new comparison.
If you specify two files or folders to compare using either the Current Folder browser or the visdiff
function, then the Comparison Tool automatically performs the default comparison type. For example,
from the Current Folder browser, if you select two XML files to compare, the tool uses the default text
comparison. To change the comparison type to a hierarchical comparison instead, create a new
comparison using the Comparison Tool.
After selecting the comparison type, click the Compare button. The comparison report opens. You
can explore the comparison report in different ways depending on the items being compared. For
more information, see the details described for each comparison type below.
You can compare any combination of folders and ZIP files using the Comparison Tool. For example,
you can compare the contents of a folder to the contents of a ZIP file. The Comparison Tool performs
a file list comparison of the selected items.
When you perform a file list comparison, a new window opens and displays the contents of the
specified lists side by side. For example, suppose that you have two folders, curvefitting and
curvefitting2, with several differences. When you compare the two folders, the Comparison Tool
displays the resulting report.
6-7
6 Managing Files in MATLAB
The Comparison Tool highlights files and subfolders that do not match using the colors listed in this
table.
• To sort the results by name, type, size, or last modified timestamp, click the corresponding column
header. For example, click the Type column header to sort by folder and file type.
• To open a detailed comparison report for items with differing content, click the compare link next
to the item.
• To open a file in the Editor, click the open link next to a file name. If the file is present in both
folders, you can click links to open the left or right version of the file.
• If subfolders are very large and contain many files, analysis continues in the background. The tool
displays the number of items still to be compared at the top of the report. You can click Skip
Current to skip the current item or Cancel All to stop further analysis.
• To save time when reviewing differences, especially when comparing many subfolders, you can
filter the report. To apply a filter, on the View tab, select Filter > "filterName".
6-8
Compare Files and Folders and Merge Files
To create a new filter, on the View tab, select Filter > Add/Remove Filter. You can specify filters
to ignore certain files and folders, such as backup files or files created by a revision control
system. For example, to ignore all files and folders in a folder named CVS, type CVS/. To ignore all
files in a folder named CVS, but not ignore subfolders, type CVS/*.
For information about how to further configure the comparison report, see “Additional Comparison
Tools” on page 6-15.
In MATLAB Online, you can compare project definition files. When you compare folders, MATLAB
detects whether they are project root folders. MATLAB looks for and compares the project definition
files stored in the resources or .SimulinkProject folder. Project definition files contain
information about the project path, project settings, shortcuts, labels, and referenced projects.
To compare project definition files, select the PRJ files or the project root folders, right-click your
selection, and select Compare Selected Files/Folders. When you select a node in the results report,
the Comparison Tool shows more details in the bottom pane.
6-9
6 Managing Files in MATLAB
6-10
Compare Files and Folders and Merge Files
Compare Files
A user made some changes to lengthofline.m and saved the resulting file as lengthofline2.m.
visdiff("lengthofline.m","lengthofline2.m")
6-11
6 Managing Files in MATLAB
The Comparison Tool displays the total number of differences in the bottom-right corner of the
comparison report and highlights the lines that have changed with the colors listed in this table.
If the files are identical or differ only in line break, you see a message reporting there are no
differences.
6-12
Compare Files and Folders and Merge Files
The Comparison Tool attempts to match lines and detects text that is added, deleted, or changed. For
example, in the text comparison of lengthofline.m and lengthofline2.m, the tool determines
that lengthofline2.m has a line of code that does not exist in lengthofline.m and highlights it
(line 22) in blue. Also, the tool takes the additional line into account and determines that the line
containing the end statement in each file matches, even though the end statement does not occur on
the same line number in both files.
You further can explore and configure the results using several methods:
• Ignore white space differences — To help distinguish between functional changes and changes to
indentation, you can hide white space differences. To hide differences that only involve white
space characters, click Filter, and select Ignore White Space.
•
Show compared files details — To show the file details, click the expand arrow next to the file
name.
• Save comparison report — To save a copy of the comparison report, select Publish > Publish to
HTML, Publish to Word, or Publish to PDF.
For information about how to further configure the comparison report, see “Additional Comparison
Tools” on page 6-15.
To step through the results one difference at a time, use the Next and Previous buttons.
By default, XML files are compared using a text comparison. To compare XML files with a
hierarchical comparison instead, see “Compare XML Files” on page 6-30.
To begin merging, on the Comparison tab, click the Merge Mode button. Then, to replace
content from the right pane with content from the left pane, click the button located next to the
line you want to merge. You also can select a difference and, in the Comparison tab, click the
Replace Content button.
The right pane contains the merged result. An asterisk next to the merged file name in the right pane
(lengthofline2.m *) indicates that the file contains unsaved changes.
To undo a replacement, click the Undo button between the modified lines or on the Comparison
tab. To revert all merges and start again, click the Refresh button. You also can click the
6-13
6 Managing Files in MATLAB
Refresh button to update the comparison report after making changes to and saving the files.
Refreshing discards all unsaved merged changes.
To save your changes and return to the comparison report, click the
Save Result
button. To return to the comparison report without saving changes, click the
Return to
Comparison button.
You can compare two binary files, such as DLL files or MEX files, using the Comparison Tool. You also
can perform a binary comparison on any two selected files, instead of the default comparison.
6-14
Compare Files and Folders and Merge Files
To compare any two files using a binary comparison, in the Comparison type menu, select Binary
comparison. When you perform a binary comparison, a new window opens and indicates whether
the two files are identical or different. If the files are different, click the Show Details link to view
the binary files and the byte offset of the first difference.
• Live Code — Compare and merge the code and text in two live code files. For more information,
see “Compare and Merge Live Scripts and Functions” on page 6-17.
• Apps — Compare and merge the code in two apps. For more information, see “Compare and
Merge Apps” on page 6-22.
• MAT-Files — Compare and merge variables in two MAT-files. For more information, see “Compare
and Merge MAT-Files” on page 6-26.
• XML Files — Compare two XML files using a text comparison or a hierarchical XML comparison.
For more information, see “Compare XML Files” on page 6-30.
• Simulink Models — If you have Simulink, you can compare and merge Simulink models. For
information, see “Model Comparison” (Simulink).
• MLDATX test files — Compare and merge Simulink Test™ test cases in MLDATX test files. For
information, see “Compare and Merge Test Files” (Simulink Test)
• Swap Sides button — Switch the left side file or folder with the right side file or folder.
• Refresh button — Update the results in the Comparison Tool after making changes to and saving
the files in the Editor.
• Find button — Find a phrase in the current display. For more information, see “Find Text in
Command Window or History” on page 3-10.
Comparison Preferences
You can customize the Comparison Tool using Comparison preferences. To change the Comparison
preferences, on the Home tab, in the Environment section, click Preferences. Then, select
MATLAB > Comparison.
Color Preferences
You can change the colors that the Comparison Tool uses to highlight lines that have changed. Color
preferences apply to all comparison types.
To change the color preferences, in the Comparison preferences Colors section, change the colors for
differences, modified lines, modified content, and merged lines. The Sample area shows a preview of
the selected colors. After changing comparison colors, you must refresh any open comparison reports
to see the updated colors.
6-15
6 Managing Files in MATLAB
To save the modified color preferences for use in future MATLAB sessions, click Save As and enter a
name for your color settings profile. After saving a color profile, you can select the profile in the
Active Settings list. To restore the default color profile, click Reset.
You can use the Comparison Tool to compare and merge files and folders in external source control
tools. To enable external source control tools to reuse open MATLAB sessions, in the Comparison
preferences External Source Control Integration section, select the Allow external source
control tools to use open MATLAB sessions for diffs and merges option. When you configure
your source control tool to use the MATLAB Comparison Tool, the Comparison Tool prompts you to
select this option.
For more information, see “Customize External Source Control to Use MATLAB for Diff and Merge”
(Simulink).
See Also
visdiff
Related Examples
• “Customize External Source Control to Use MATLAB for Diff and Merge”
External Websites
• Programming: Structuring Code (MathWorks Teaching Resources)
6-16
Compare and Merge Live Scripts and Functions
You can compare two live code files and merge changes between one file and another using the
Comparison Tool. The Comparison Tool highlights differences in code, text, and text formatting.
• Live Editor — Go to the Live Editor tab and, in the File section, click Compare. The Comparison
Tool includes the currently open file in the First file or folder field. Click the button to select a
second item to compare, or drag and drop a file from your file browser into the Second file or
folder field.
• Current Folder browser — Select a file, right-click, and select Compare Against. Click the
button to select a second item to compare, or drag and drop a file from your file browser into the
Second file or folder field. To select two files or subfolders to compare, Ctrl-click the file names.
Then right-click and select Compare Selected Files/Folders.
• Command Window — Use the visdiff function. For example, to compare the two files
averageweight.mlx and averageweight2.mlx using the visdiff function and the default
text comparison, type visdiff('averageweight.mlx','averageweight2.mlx'). MATLAB
opens the Comparison Tool and displays the resulting comparison report.
Explore Differences
When you compare MLX files, a new window opens and displays the two files side by side. For
example, suppose that you have two files, averageweight.mlx and averageweight2.mlx, with
several differences. When you compare the two files, the Comparison Tool displays the resulting
report.
6-17
6 Managing Files in MATLAB
When comparing live code files, the Comparison Tool highlights differences in code, text, and text
formatting. The Comparison Tool ignores output, even if the file contains saved output. If the tool
detects a difference within an equation, image, or control, the entire item is highlighted. The
Comparison Tool displays the total number of differences in the bottom-right corner of the
comparison report, and highlights the lines that do not match using the colors listed in this table.
6-18
Compare and Merge Live Scripts and Functions
The Comparison Tool attempts to match lines and detects code and text that is added, deleted, or
changed. For example, in the live code comparison of averageweight.mlx and
averageweight2.mlx, the tool determines that averageweight.mlx has two lines of code that do
not exist in averageweight2.mlx and highlights them (line 5 and line 7) in yellow. Also, the tool
takes the additional lines into account and determines that the line containing the disp statement in
each file matches, even though the disp statement does not occur on the same line number.
To step through the results one difference at a time, use the Previous and Next buttons.
For information about how to configure the comparison report, see “Compare Files and Folders and
Merge Files” on page 6-6.
Merge Changes
When comparing live code files, you can merge changes from one file to the other. Merging changes
can be useful when resolving conflicts between different versions of files. You only can merge from
left to right. If you want to merge into the left file, click the Swap Sides button before you start
merging. Clicking the Swap Sides button reverts any merges already made and creates a new
comparison report for the original files.
To begin merging, on the Comparison tab, click the Merge Mode button. Then, to replace
content from the right pane with content from the left pane, click the button located next to the
line you want to merge. You also can select a difference and, in the Comparison tab, click the
Replace Content button.
The right pane contains the merged result. An asterisk next to the merged file name in the right pane
(averageweight2.mlx *) indicates that the file contains unsaved changes.
6-19
6 Managing Files in MATLAB
To undo a replacement, click the Undo button between the modified lines or on the Comparison
tab. To revert all merges and start again, click the Refresh button. You also can click the
Refresh button to update the comparison report after making changes to and saving the files in the
Live Editor. Refreshing discards all unsaved merged changes.
To save your changes and return to the comparison report, click the
Save Result
button. To return to the comparison report without saving changes, click the
Return to
Comparison button.
See Also
visdiff
More About
• “Compare Files and Folders and Merge Files” on page 6-6
6-20
Compare and Merge Live Scripts and Functions
• “Customize External Source Control to Use MATLAB for Diff and Merge”
6-21
6 Managing Files in MATLAB
• App Designer — Go to the Designer or Editor tab and, in the File section, click Compare To.
The Comparison Tool includes the currently open file in the First file or folder field. Click the
button to select a second item to compare, or drag and drop a file from your file browser into the
Second file or folder field.
• Current Folder browser — Select a file, right-click, and select Compare Against. Click the
button to select a second item to compare, or drag and drop a file from your file browser into the
Second file or folder field. To select two files or subfolders to compare, Ctrl-click the file names.
Then right-click and select Compare Selected Files/Folders.
• Command Window — Use the visdiff function. For example, to compare the two files
ExplorerE.mlapp and ExplorerF.mlapp using the visdiff function and the default text
comparison, type visdiff('ExplorerE.mlapp','ExplorerF.mlapp'). MATLAB opens the
Comparison Tool and displays the resulting comparison report.
Explore Differences
When you perform an app comparison, a new window opens and displays the two files side by side.
For example, suppose that you have two files ExplorerE.mlapp and ExplorerF.mlapp with
several differences. When you compare the two files, the Comparison Tool displays the resulting
report.
6-22
Compare and Merge Apps
When comparing apps, the Comparison Tool attempts to match lines and detects code that is added,
deleted, or changed. The Comparison Tool displays the total number of differences in the bottom-right
corner of the comparison report and highlights the lines that do not match using the colors listed in
this table.
To step through the results one difference at a time, use the Next and Previous buttons.
6-23
6 Managing Files in MATLAB
For information about how to configure the comparison report, see “Compare Files and Folders and
Merge Files” on page 6-6.
Merge Changes
When comparing apps, you can merge changes from one app to the other. Merging changes can be
useful when resolving conflicts between different versions of an app.
To begin merging, on the Comparison tab, click the Merge Mode button. Then, to replace
content from the right pane with content from the left pane, click the button located next to the
line you want to merge. You also can select a difference and, in the Comparison tab, click the
Replace Content button.
The right pane contains the merged result. An asterisk next to the merged file name in the right pane
(ExplorerF.mlapp*) indicates that the file contains unsaved changes.
To undo a replacement, click the Undo button between the modified lines or on the Comparison
tab. To revert all merges and start again, click the Refresh button. You also can click the
Refresh button to update the comparison report after making changes to and saving the files in the
Live Editor. Refreshing discards all merged changes.
To save your changes and return to the comparison report, click the
Save Result
button. To return to the comparison report without saving changes, click the
Return to
Comparison button.
6-24
Compare and Merge Apps
You can merge changes only in editable code. Sections of code with a white background are editable.
Examples of editable sections include the body of functions that you define (such as callbacks and
helper functions) and the definitions of custom properties. Sections with a gray background contain
non-editable generated code and therefore cannot be merged. If a change spans both an editable and
a non-editable section, you cannot merge it.
You can merge changes only from left to right. This makes the order of the files in the Comparison
Tool important.
If neither app contains changes in the generated code, place the file containing the changes that you
want to merge in the left pane. You can merge only from left to right. To swap a file from the left pane
to the right pane, click the Swap Sides button before you start merging. Clicking the Swap
Sides button reverts any merges already made and creates a new comparison report for the original
files.
If one of the apps contains changes in the generated code, place the file containing the generated
code that you want in the merged result in the right pane of the Comparison Tool. To swap a file from
the left pane to the right pane, click the Swap Sides button before you start merging.
If both apps contain changes in the generated code, those lines of code cannot be merged in the
Comparison Tool. To merge the files, use App Designer to interactively apply the desired changes to
the app
See Also
visdiff
More About
• “Compare Files and Folders and Merge Files” on page 6-6
• “Customize External Source Control to Use MATLAB for Diff and Merge”
6-25
6 Managing Files in MATLAB
You can use the Comparison Tool to compare two MAT-files. Compare two MAT-files to:
• Determine which variables are common to both files and which appear in only one file.
• Identify differences between individual variables. For example, you can determine which fields of
a structure are different or which elements of an array differ.
• MATLAB desktop — Go to the Home tab and, in the File section, click Compare. Click the
Browse to select File or Folder button to select items to compare, or drag and drop files
from your file browser into the First file or folder or Second file or folder fields.
• Current Folder browser — Select a file, right-click, and select Compare Against > Choose....
Click the Browse to select File or Folder button to select a second item to compare, or drag
and drop a file from your file browser into the Second file or folder field. To select two files or
subfolders to compare, Ctrl-click the file names. Then right-click and select Compare Selected
Files/Folders.
• Command Window — Use the visdiff function. For example, to compare the two files
data1.mat and data2.mat using the visdiff function, type
visdiff('data1.mat','data2.mat'). MATLAB opens the Comparison Tool and displays the
resulting comparison report.
Explore Differences
When you perform a MAT-file comparison, a new window opens and displays the two files side by side.
For example, suppose that you have two MAT-files, data1.mat and data2.mat. When you compare
the two files, the Comparison Tool displays the resulting report.
6-26
Compare and Merge MAT-Files
The Comparison Tool highlights changes in variables. If the variables in both files are equivalent but
the files are not identical, the Comparison Tool displays a message. Possible causes of the differences
between the files include file formats, file timestamps, the order in which the variables are stored, or
variables that contain ignored differences. The Comparison Tool uses these colors to highlight
differences.
Highlighting Description
Purple Values of the variable differ between the two files. Click the compare link
to investigate.
Blue The variable only exists in the right file.
Yellow The variable only exists in the left file.
None The variables in both files are equivalent. The tool ignores differences in
NaN patterns, field ordering in structs, and the difference between
negative zero or positive zero.
Purple (only in Class The variable data class changed. Click the compare link to investigate.
columns)
You can further explore the results in the report using several methods:
6-27
6 Managing Files in MATLAB
• Sort results — To sort the results by name, size, class, or difference summary, click the
corresponding column header. For example, click the Class column header to sort by class type.
• Load variable — To load the contents of a variable into the Variable Editor, click the name of that
variable.
• Load MAT-file — To load one of the MAT-files into the workspace, click the corresponding Load
link at the bottom of the report.
• Save HTML report — To save a copy of the report as an HTML file, go to the Comparison tab and
click Save As > HTML.
For information about how to further configure the comparison report, see “Compare Files and
Folders and Merge Files” on page 6-6.
Compare Variables
To investigate differences between instances of a variable in both files, click the compare link in the
Difference Summary column of the comparison report table. The Comparison Tool displays a report
for the specified variable. To further investigate differences in individual array elements or fields of a
structure, double-click a highlighted row.
Merge Changes
When comparing MAT-files, you can merge changes from one file to the other. There are no undo
capabilities when merging MAT-files, so merge with caution.
To copy modified variables from one file to the other, on the Comparison tab, in the Merge section,
click either the Copy the right variable to the left file or the Copy the left variable to the
right file button, as applicable.
Limitations
In MATLAB Online, the File Comparison Tool does not support variable comparison.
6-28
Compare and Merge MAT-Files
See Also
visdiff
More About
• “Compare Files and Folders and Merge Files” on page 6-6
• “Customize External Source Control to Use MATLAB for Diff and Merge”
6-29
6 Managing Files in MATLAB
In this section...
“Choose XML Files to Compare” on page 6-30
“Change Comparison Type” on page 6-31
“Navigate the XML Comparison Report” on page 6-31
“Save Comparison Log Files in a Zip File” on page 6-32
“Export Results to the Workspace” on page 6-33
You can use the Comparison Tool to compare a pair of XML text files. The tool processes the results
into a report that you can use to explore the file differences. You can compare XML files with a text
comparison or a hierarchical XML comparison.
You can access the XML Comparison Tool from the Current Folder browser, the Comparison Tool, or
programmatically using the visdiff function.
The XML comparison compares the files using the “Chawathe” algorithm, as described in this paper:
Change Detection in Hierarchically Structured Information, Sudarshan Chawathe, Anand Rajaraman,
and Jennifer Widom; SIGMOD Conference, Montreal, Canada, June 1996, pp. 493-504.
XML comparison reports display in the Comparison Tool. For more information about the Comparison
Tool, see “Compare Files and Folders and Merge Files” on page 6-6.
The XML comparison report shows a hierarchical view of the portions of the two XML files that differ.
The report does not show sections of the files that are identical.
If the files are identical or differ only in line break, you see a message reporting there are no
differences.
Note It might not be possible for the analysis to detect matches between previously corresponding
sections of files that have diverged too much.
Change detection in the Chawathe analysis is based on a scoring algorithm. Items match if their
Chawathe score is above a threshold. The implementation of Chawathe's algorithm uses a comparison
pattern that defines the thresholds.
• For two files in the same folder, select the files, right-click and select Compare Selected Files/
Folders.
• To compare files in different folders:
6-30
Compare XML Files
The XML Comparison Tool performs an analysis on the files and displays a report in the Comparison
Tool. The file you right-click to open the XML Comparison Tool displays on the right side of the report.
For more information about comparisons of other file types with the Comparison Tool, such as text,
MAT, or binary, see “Compare Files and Folders and Merge Files” on page 6-6.
To compare files using the Comparison Tool, from the MATLAB toolstrip, in the File section, select
the Compare button. In the dialog box, select files to compare.
If the files you select to compare are XML files and you select an XML text comparison, the XML
Comparison Tool performs a Chawathe analysis of the XML files, and generates a report.
To change comparison type, either create a new comparison from the Comparison Tool, or use the
Compare Against option from the Current Folder browser. You can change comparison type in the
Select Files or Folders for Comparison dialog box. Select XML text comparison before clicking
Compare.
To step through differences, use the Comparison tab on the toolstrip. To move to the next or
previous group of differences, on the Comparison tab, in the Navigate section, click the arrow
buttons to go to the previous or next difference.
6-31
6 Managing Files in MATLAB
Container None Rows with no highlighting indicate a container item that contains
other modified or unmatched items.
Use the View tab controls on the toolstrip for the following functions:
Tip Right-click to expand or collapse the hierarchy within the selected tree node.
• Collapse All — Collapses all items in the tree to the most compact view possible.
Note It may not be possible for the analysis to detect matches between previously corresponding
sections of files that have diverged too much.
You can zip the temporary files (such as log files) created during XML comparisons, for sharing or
archiving. While the comparison report is open, enter:
xmlcomp.zipTempFiles('c:\work\myexportfolder')
The destination folder must exist. The output reports the zip file name:
6-32
Compare XML Files
To view the log file for the last comparison in the MATLAB Editor, enter:
xmlcomp.showLogFile
1 On the Comparison tab, in the Comparison section, select Save As > Workspace variable.
The xmlcomp.Edits object contains information about the XML comparison including file names,
filters applied, and hierarchical nodes that differ between the two XML files.
To create an xmlcomp.Edits object at the command line without opening the Comparison Tool,
enter:
Edits = xmlcomp.compare(a.xml,b.xml)
6-33
6 Managing Files in MATLAB
See Also
Related Examples
• “Compare Files and Folders and Merge Files” on page 6-6
6-34
Manage Files and Folders
This table shows how to create, open, move, and rename files and folders on local and network
drives. If you have MATLAB Connector installed on your system, you also can access files and folders
in MATLAB Drive™ from MATLAB.
6-35
6 Managing Files in MATLAB
To open the Current Folder browser if it is not visible, go to the Home tab, and in the Environment
section, click Layout. Then, under Show, select Current Folder. Double-clicking a subfolder
displays its contents, and makes that folder the current folder.
For more information about how to access files in MATLAB Online, see “Access Files in MATLAB
Online” on page 10-2.
See Also
edit | mkdir | open | movefile | rmdir | delete | recycle
6-36
Manage Files and Folders
More About
• “Save and Back Up Code”
• “Save and Load Workspace Variables” on page 5-12
• “Errors When Updating Folders on Search Path” on page 6-61
• “Access Files in MATLAB Online” on page 10-2
• “Share Folders Using MATLAB Drive” on page 12-15
6-37
6 Managing Files in MATLAB
In this section...
“Where Does MATLAB Look for Files?” on page 6-38
“Files and Folders You Should Add to the Search Path” on page 6-38
“When Multiple Files Have the Same Name” on page 6-38
“Locations of MathWorks Products” on page 6-39
• Change the current folder to the folder that contains the files. Use the cd function or browse to a
different folder in the Current Folder toolbar:
• Add the folder that contains the files to the search path. Changes you make to the search path
apply to the current MATLAB session. To reuse the modified search path in future MATLAB
sessions, save your changes.
• Store individual files in the userpath MATLAB folder, which is on the search path. To determine
the location of this folder, run the userpath function.
For files in @ (class) and + (namespace) folders, make the parent folder accessible. For details, see
“Folders Containing Class Definitions”.
If files call other files that are in multiple folders, determine the location of all the called files by
performing a dependency analysis on your files. For more information, see “Dependencies Within a
Folder”
6-38
Files and Folders That MATLAB Accesses
Name conflicts arise when MATLAB has access to multiple files with the same name, and when a file
has the same name as a variable in the base workspace or a built-in function for a MathWorks
product.
When there are name conflicts, MATLAB follows these precedence rules:
The file that MATLAB does not use is called a shadowed file. In some cases, MATLAB warns you that a
shadowed file exists.
To see a list of all toolbox folder names supplied with MathWorks products, run:
dir(fullfile(matlabroot,'toolbox'))
See Also
userpath | cd | pwd
More About
• “What Is the MATLAB Search Path?” on page 6-47
• “MATLAB Startup Folder” on page 1-15
• “Toolbox Path Caching in MATLAB” on page 1-22
6-39
6 Managing Files in MATLAB
You can specify the number of files that display in the Current Folder browser, and customize their
appearance.
On the Home tab, in the Environment section, click Preferences. Then, select MATLAB >
Current Folder.
Some Current Folder Browser preferences are not available in MATLAB Online.
Preference Usage
History Specify the number of recently used folders maintained in the Current
Folder toolbar drop-down list.
Refresh Specify how frequently the Current Folder browser updates to reflect
changes to files made from programs and tools other than MATLAB.
Select the Indicate inaccessible files check box to dim the display of
files and folders inaccessible to MATLAB. Move the Text and icon
transparency slider to adjust the level of dimming.
Select the Show tooltip explaining why files are inaccessible check
box to display a tooltip that provides information on why a dimmed file
is inaccessible, when you hover over it.
If you do not select the Indicate inaccessible files check box, then the
Current Folder browser displays all files and folders as undimmed and
provides no tooltips.
Toolbar Use the Toolbar preferences to adjust the layout and controls of the
Current Folder toolbar. For more information about how to access
Toolbar preferences, see “Customize MATLAB Toolbars” on page 2-12.
Initial working folder Use the General Preferences options in the Preferences Window to
specify the current folder in MATLAB at startup. For more information
about General Preferences options, see Preferences.
6-40
Current Folder Browser Preferences
Preference Usage
Hidden Files Specify whether the Current Folder browser displays files and folders
that the operating system hides from system file browsers and file-
listing commands.
To change how dates display in the Current Folder browser, change the short date format for your
operating system. Then, refresh the date display: Right-click in the Current Folder browser and select
Refresh. MATLAB uses your operating system's short date format to display dates in both the
Current Folder browser and the Command History.
See Also
Preferences
More About
• “Manage Files and Folders” on page 6-35
• “Customize MATLAB Toolbars” on page 2-12
6-41
6 Managing Files in MATLAB
A path name specifies file locations, for example, C:\work\my_data (on Microsoft Windows
platforms) or /usr/work/my_data (on Linux or Mac platforms). If you do not specify a path name
when accessing a file, MATLAB first searches in the current folder. To indicate a file in a particular
location, specify a path name.
Path name specifications differ, depending on the platform on which you are running MATLAB. Use
the fullfile function to construct path names in statements that work on any platform. This
function is particularly useful when you provide code to someone using it on a platform other than
your own.
fullfile inserts platform-specific file separators where necessary. The file separator character is
the symbol that distinguishes one folder level from another in a path name. A forward slash (/) is a
valid separator on any platform. A backward slash (\) is valid only on Microsoft Windows platforms. In
the full path to a folder, the final slash is optional. Type filesep in the Command Window to
determine the correct file separator character to use on your platform.
To identify the platform on which MATLAB is currently running, use the ismac, ispc, and isunix
functions.
File names must start with a letter, and can contain letters, digits, or underscores.
Avoid using accent characters such as umlauts or circumflexes in path names. MATLAB might not
recognize the path. In addition, attempts to save a file to such a path might result in unpredictable
behavior.
If a path or file name contains spaces, enclose the input in single quotes. For example:
or
MATLAB always accepts absolute path names (also called full path names), such as I:/Documents/
My_Files or /users/myuserid/Homework/myfile.m. An absolute path name can start with any
of the following:
6-42
Specify File Names
Some MATLAB functions also support relative path names. Unless otherwise noted, the path name is
relative to the current folder. For example:
Tip If multiple documents are open and docked in the Editor, you can copy the absolute path of any
of these documents to the clipboard. This practice is useful if you need to specify the absolute path in
another MATLAB tool or an external application. Right-click the document tab, and then select Copy
Full Path to Clipboard.
A partial path name is the last portion of a full path name for a location on the MATLAB search path.
Some functions accept partial path names.
open database/set
• Locate method files. For example, to check if a plot method exists for the time series object, type:
exist timeseries/plot
Be sure to specify enough of the path name to make the partial path name unique.
The maximum length allowed for a path name depends on your platform.
6-43
6 Managing Files in MATLAB
If you get unexpected results when working with long path names, use absolute instead of relative
path names. Alternatively, use shorter names for folders and files.
You call function files by specifying the file name without the file extension. MATLAB returns an error
if it cannot find a case-sensitive match on the search path. By default, MATLAB suggests a function
with the correct case.
When multiple files have the same name, MATLAB follows precedence rules to determine which to
call. For more information, see “Function Precedence Order”.
• When loading or reading from a file, specify the file name using the correct case.
• When saving or writing to a file, MATLAB saves the file in the case you specify. Two files with the
same name, but different cases can exist in the same folder.
Windows platforms — File names are case insensitive. The Windows operating system considers
two files with the same name to be the same file, regardless of case. Therefore, you cannot have two
file names that differ only by case in the same folder.
• When loading or reading from a file, MATLAB accesses the file with the specified name that is
higher on the search path, regardless of case. For example, if you attempt to load MYFILE and
myfile.mat is higher on the search path than MYFILE.MAT, then MATLAB loads myfile.mat
without warning that there is a case mismatch.
• When saving or writing to a file, if you specify a file name that already exists in the folder,
MATLAB accesses the existing file without warning. For example, if you save data to a file named
myfile using the save function, and MYFILE.mat already exists in the folder, the data replaces
the contents of MYFILE.mat. However, the file name remains MYFILE.mat.
See Also
filesep | fullfile | which | ismac | ispc | isunix
More About
• “What Is the MATLAB Search Path?” on page 6-47
6-44
Create and Extract from Zip Archives
• To create an empty zip file, right-click white space, and then select New > Zip File.
• To create a populated zip file from selected files and folders, select the folders and files you want
to archive, right-click, and then select Create Zip File.
MATLAB creates an archive with a default name of Untitledn.zip, where n is an integer. Type over
the default file name to specify a descriptive name.
You also can create zip archives programmatically using the zip function. For example, to zip all files
with a .m and .mat extension in the current folder to a zip file archive named backup.zip, call:
zip('backup',{'*.m','*.mat'});
• Select, and then drag the file that you want to add onto the archive.
• Copy the file that you want to add to the archive. Then, select the archive to which you want to
add the file and paste the file into the archive.
1 Expand the zip file archive to view the archive contents, by clicking the associated + (expand)
button. By default, files within a zip file archive appear dimmed to indicate that they are not on
the MATLAB path.
2 Drag the file into a folder in the Current Folder browser.
MATLAB extracts the file and saves it to the folder where you dragged or pasted it.
To extract all the contents of a zip file, double-click the zip file in the Current Folder browser.
MATLAB creates a folder with the same name as the zip file, and extracts the entire contents of the
zip file into this folder.
6-45
6 Managing Files in MATLAB
To extract the contents of a zip file programmatically, use the unzip function. unzip also allows you
to specify a target folder. For example, to unzip the file, examples.zip, to a folder named
myfolder, call:
unzip('examples.zip','myfolder')
Note Archives created outside of MATLAB can be encrypted or password-protected. You cannot add
files to, or extract files from, protected archives from within MATLAB.
• Right-click a zip archive, and then from the context menu select Compare Against and specify
the folder to which you want to compare the contents of the zip archive.
• Expand a zip archive, right-click a file within it, and then from the context menu select Compare
Against. Specify the file to which you want to compare the archived file.
See Also
unzip | zip
More About
• “Compare Files and Folders and Merge Files” on page 6-6
6-46
What Is the MATLAB Search Path?
The order of folders on the search path is important. When files with the same name appear in
multiple folders on the search path, MATLAB uses the one found in the folder nearest to the top of
the search path.
• The MATLAB userpath folder, which is added to the search path at startup, and is the default
location for storing user files
• The folders defined as part of the MATLABPATH environment variable
• The folders provided with MATLAB and other MathWorks products, which are under
matlabroot/toolbox, where matlabroot is the folder displayed when you run matlabroot in
the Command Window
Class, namespace, private, and resources folders are special folders that cannot be specified
explicitly as part of the search path. A special folder is added to the search path implicitly when its
parent folder is specified as part of the path. To access the files and folders within a special folder,
you must add its parent folder to the path.
You can explicitly add folders to the search path for the files you run. For more information about
adding files to the search path, see “Change Folders on Search Path” on page 6-50.
By default, the userpath folder is also the startup folder when you start MATLAB by double-clicking
either the MATLAB shortcut on Windows systems or the MATLAB application on Mac systems.
6-47
6 Managing Files in MATLAB
To determine whether a file is on the search path, run which filename. If the file is on the search
path, MATLAB returns the full path to the file.
To determine whether a file or folder is on the search path, use the Current Folder browser. Files and
folders not on the path are dimmed. To ensure that the Current Folder browser is set to indicate
whether a file or folder in on the search path, right-click any file or folder, and select the Indicate
Files Not on Path option.
Hover the pointer over any dimmed file or folder in the Current Folder browser to find out why it is
dimmed. A tooltip opens with an explanation. Frequently, the tooltip indicates that the file or folder is
not on the MATLAB path. If a tooltip does not appear, it may be disabled. To enable it, go the Home
tab and in the Environment section, click Preferences. Then, select MATLAB > Current
Folder. Select Show tooltip explaining why files are inaccessible to display the tooltip.
Run the path command to view all the folders on the MATLAB search path.
Alternatively, use the Set Path dialog box to view the entire MATLAB search path. On the Home tab,
in the Environment section, click Set Path. The Set Path dialog box opens, listing all folders on the
search path. For more information on using the Set Path dialog box, see “Change Folders on Search
Path” on page 6-50.
6-48
What Is the MATLAB Search Path?
MATLAB saves search path information in the pathdef.m file. This file contains a series of full path
names, one for each folder on the search path.
When you change the search path, MATLAB uses it in the current session, but does not update
pathdef.m. To use the modified search path in the current and future sessions, save the changes
using savepath or the Save button in the Set Path dialog box. This updates pathdef.m.
In MATLAB Online, all changes to the search path are automatically saved.
See Also
userpath
More About
• “Add Folders to the MATLAB Search Path at Startup” on page 6-55
• “Change Folders on Search Path” on page 6-50
6-49
6 Managing Files in MATLAB
In this section...
“Add or Remove Folders on the Search Path Programmatically” on page 6-50
“Change Folders on Search Path Interactively” on page 6-50
“Change Folders Using Current Folder Browser” on page 6-52
“Change Folders on Search Path Using MATLAB Editor” on page 6-53
You can programmatically and interactively add or remove folders and change the order of MATLAB
folders on the search path, for the current session and future sessions. When files with the same
name appear in multiple folders on the search path, MATLAB uses the one in the folder nearest to the
top of the search path.
addpath("c:\matlab\MyFolder")
You can remove one or more folders from the path using the rmpath function.
rmpath("c:\matlab\MyFolder")
To save changes to the search path across MATLAB sessions, use the savepath function. This
function also saves changes that you make interactively with the Set Path dialog box, from the
Current Folder browser, or in the MATLAB Editor.
In MATLAB Online, changes to the path are automatically saved. Therefore, calling savepath is not
necessary.
1 On the Home tab, in the Environment section, click Set Path. The Set Path dialog box appears.
Alternatively, you can access this dialog box using the pathtool function.
6-50
Change Folders on Search Path
2 Use the Add Folder or Add Folder with Subfolders button to add new folders to MATLAB
search path.
3 Use the Move Down and Move Up buttons to change the order of files on the search path. Files
contained in folders at the top of the search path have precedence over those in folders farther
down. For more information, see “Function Precedence Order”.
4 Apply or cancel the search path changes:
• To use the newly modified search path only in the current session, click Close.
• To reuse the newly modified search path in the current session and future sessions, click
Save, and then Close.
• To undo your changes, click Revert, and then Close.
• To restore the default search path, click Default, and then Close. The default search path
contains only folders provided by MathWorks.
Note The MATLAB (userpath) folder automatically moves to the top of the search path the next time
you start MATLAB. For more information about the userpath folder, see “userpath Folder on the
Search Path” on page 6-47.
In MATLAB Online, you can use the buttons at the top of the Set Path dialog box to add folders to the
search path and revert changes to the search path. To make changes to an existing folder on the
6-51
6 Managing Files in MATLAB
search path, right-click the folder and select from the available options. To search for folders on the
path, use the search field at the top of the Set Path dialog box.
1 From the Current Folder browser, right-click the folder or select and then right-click multiple
folders to add or remove.
2 From the context menu, select Add to Path or Remove from Path, and then select an option:
• Selected Folders
• Selected Folders and Subfolders
Changes to the search path using this method do not persist in future MATLAB sessions. To save
these changes, use savepath.
6-52
Change Folders on Search Path
Changes to the search path using this method do not persist in future MATLAB sessions. To save
these changes, use savepath.
See Also
addpath | rmpath | savepath
More About
• “What Is the MATLAB Search Path?” on page 6-47
6-53
6 Managing Files in MATLAB
To use your files with a new MATLAB version or with multiple versions, do one of the following:
• For each version, add the folders containing your files to the search path. Save the search path
(that is, save the pathdef.m file) where that version of MATLAB can access it.
• Include addpath statements in the startup.m file. Use the same startup.m file with the
multiple versions of MATLAB.
Including addpath statements in the startup.m file also allows you to use your files with MATLAB
on different platforms.
See Also
addpath
More About
• “Startup Options in MATLAB Startup File” on page 1-20
6-54
Add Folders to the MATLAB Search Path at Startup
addpath /home/username/mytools
For more information on creating a startup.m file with addpath statements, see “Startup Options
in MATLAB Startup File” on page 1-20.
Windows
To set the MATLABPATH environment variable in Windows, from the Windows Control Panel, go to
System and select Advanced system settings. Click the Environment Variables... button. Click
New... or Edit... to create or edit the MATLABPATH environment variable. In the dialog box that
appears, set the variable name to MATLABPATH and the variable value to a semicolon-separated list of
folders you want to add to the search path. For example, to add two folders, c:\matlab_files
\myfolder1 and c:\matlab_files\myfolder2, to the MATLABPATH environment variable, enter
c:\matlab_files\myfolder1;c:\matlab_files\myfolder2 as the variable value. Click OK to
set the variable and exit the dialog box. Restart MATLAB for the new settings to take effect.
To set the environment variable from a command window, run the command set
MATLABPATH=folders, where folders is a semicolon-separated list of folders. For example,
suppose that you want to add two folders, c:\matlab_files\myfolder1 and c:\matlab_files
\myfolder2, to the MATLABPATH environment variable. Run the command
set MATLABPATH=c:\matlab_files\myfolder1;c:\matlab_files\myfolder2
Once the environment variable is set, you must start MATLAB from the same command window for
the settings to take effect. The environment variable persists only as long as the command window is
open.
To set the MATLABPATH environment variable in UNIX and Mac, in a terminal, run the command
export MATLABPATH=folders, where folders is a colon-separated list of folders.
For example, suppose that you want to add two folders, /home/j/Documents/MATLAB/mine and /
home/j/Documents/MATLAB/research, to the MATLABPATH environment variable on a UNIX
platform. Run the command
export MATLABPATH=/home/j/Documents/MATLAB/mine:/home/j/Documents/MATLAB/research
6-55
6 Managing Files in MATLAB
Once the environment variable is set, you must start MATLAB from the same shell for the settings to
take effect. The environment variable persists only as long as the shell remains open.
Note If you are using a C shell (csh or tcsh), the command for setting the MATLABPATH
environment variable is setenv MATLABPATH folders.
To add the folders for all future MATLAB sessions, set the MATLABPATH environment variable as part
of your shell configuration script.
See Also
More About
• “What Is the MATLAB Search Path?” on page 6-47
• “Change Folders on Search Path” on page 6-50
6-56
Assign userpath as Startup Folder (Macintosh or UNIX)
Using a bash shell, set the MATLAB_USE_USERWORK environment variable so that userpath will be
used as the startup folder.
export MATLAB_USE_USERWORK=1
From that shell, start MATLAB. Next, verify the current folder in MATLAB.
pwd
/Users/smith/Documents/MATLAB
Confirm that this is the same as the folder defined for userpath.
userpath
/Users/smith/Documents/MATLAB;
path
/Users/smith/Documents/MATLAB
/Users/smith/Applications/MATLAB/R2009a/toolbox/matlab/general
/Users/smith/Applications/MATLAB/R2009a/toolbox/matlab/ops
...
6-57
6 Managing Files in MATLAB
Issue
When MATLAB starts, if there is a problem with the search path, then the following message appears:
If there is a problem with the search path, you cannot use MATLAB successfully. Search path
problems occur when:
• You save the search path on a Windows platform, and then try to use the same pathdef.m file on
a Linux platform.
• The pathdef.m file becomes corrupt, invalid, renamed, or deleted.
• MATLAB cannot locate the pathdef.m file.
Possible Solutions
For problems with the search path, try these recovery steps. Proceed from one possible solution to
the next only as necessary. After correcting problems with the search path, make any changes to run
your files. For example, us userpath to add the userpath folder to the search path or use addpath
to add other folders to the search path.
which pathdef
If you want MATLAB to use the pathdef.m file at another location, make corrections. For example,
delete the incorrect pathdef.m file and ensure the correct pathdef.m file is in a location that
MATLAB can access.
Look for and correct problems with the pathdef.m and startup.m files by following these steps:
1 Open pathdef.m and startup.m in a text editor. Depending on the problem, you might not be
able to open the pathdef.m file.
2 Look for obvious problems, such as invalid characters or path names.
3 Make corrections and save the files.
4 Restart MATLAB to ensure that the problem does not recur.
Run restoredefaultpath, which sets the search path to the default and stores it in matlabroot/
toolbox/local. If restoredefaultpath seems to correct the problem, run savepath.
6-58
Resolve Issue: MATLAB Did Not Appear to Successfully Set the Search Path
Depending on the problem, the following message could appear during this workflow:
The path may be bad. Please save your work (if desired), and quit.
Try to correct the problem using the Set Path dialog box. On the Home tab, in the Environment
section, click Set Path. The Set Path dialog box appears. Alternatively, you can access this dialog box
using the pathtool function.
Click Default to restore the default search path and then click Save to save it. See “Change Folders
on Search Path” on page 6-50 for additional information on using the Set Path Dialog box.
Depending on the problem, you might not be able to open the dialog box.
restoredefaultpath; matlabrc
6-59
6 Managing Files in MATLAB
Once the command completes, if there is a pathdef.m file in the startup folder, then it caused the
problem. Either remove the problematic pathdef.m file or replace it with a functional pathdef.m
file. For example, run:
savepath('path_to_your_startup_folder/pathdef.m')
See Also
restoredefaultpath | pathtool | userpath
Related Examples
• “What Is the MATLAB Search Path?” on page 6-47
• “MATLAB Startup Folder” on page 1-15
• “Change Folders on Search Path” on page 6-50
6-60
Errors When Updating Folders on Search Path
The behavior varies by platform because it depends on the behavior of similar features in the
operating system.
If your task fails and the error message indicates it is because the folder is on the search path, then
do the following:
6-61
6 Managing Files in MATLAB
When MATLAB is unable to obtain a valid or responsive Change Notification Handle, it cannot
automatically detect changes to files and folders. For example, new functions added to an affected
folder might not be visible, and changed functions in memory might not be reloaded.
If your file system updates folder timestamps when files are added to folders, you can set your system
remote path policy to detect changes by testing the timestamps of folders. To do so, include these
commands in a startup.m file. For more information on creating a startup.m file, see “Startup
Options in MATLAB Startup File” on page 1-20.
system_dependent('RemotePathPolicy', 'TimecheckDir');
rehash path;
You might notice a performance degradation due to the time required to check the timestamps.
If your file system does not update folder timestamps (such as an NT file system), you can set your
system remote path policy to detect changes by rereading the affected folders at frequent intervals.
To do so, include these commands in a startup.m file.
system_dependent('RemotePathPolicy', 'Reload');
rehash path;
You might notice a significant performance degradation due to the time required to reread the
folders.
In some cases, detecting new files or changed files in folders affected by the invalid or unresponsive
change notification handles is not necessary. If detecting changes is not necessary, to provide
maximum performance, you can disable your system remote path policy. To do so, include these
commands in a startup.m file.
system_dependent('RemotePathPolicy', 'None');
rehash path;
6-62
Troubleshoot Invalid or Unresponsive Windows Change Notification Handles
• Show warning messages for all invalid or unresponsive change notification handles.
system_dependent('DirChangeHandleWarn', 'Always');
• Only show the first warning message about invalid or unresponsive change notification handles.
system_dependent('DirChangeHandleWarn', 'Once');
• Never show warning messages about invalid or unresponsive change notification handles.
system_dependent('DirChangeHandleWarn', 'Never');
To determine when Windows warns about invalid or unresponsive change notification handles, use
this command.
system_dependent('DirChangeHandleWarn', 'Status');
See Also
addpath | rehash
More About
• “What Is the MATLAB Search Path?” on page 6-47
• “Startup Options in MATLAB Startup File” on page 1-20
6-63
7
Editor Preferences
Editor/Debugger Preferences
In this section...
“General Preferences for the Editor/Debugger” on page 7-2
“Editor/Debugger Display Preferences” on page 7-4
“Editor/Debugger Tab Preferences” on page 7-5
“Editor/Debugger Language Preferences” on page 7-5
“Editor/Debugger Code Folding Preferences” on page 7-8
“Editor/Debugger Backup Files Preferences” on page 7-9
“Editor/Debugger Autoformatting Preferences” on page 7-10
“Editor/Debugger Automatic Completions Preferences” on page 7-11
“Editor/Debugger Find and Replace Preferences” on page 7-14
“Editor/Debugger Indenting Preferences” on page 7-15
“Editor/Debugger Saving Preferences” on page 7-16
You can customize the visual display and functionality of the Editor, Live Editor, and Debugger using
Editor/Debugger preferences.
You can specify which editor MATLAB uses, as well as how the MATLAB Editor and Live Editor
behave under various circumstances.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger, and
then adjust preference options as described in the table below.
Preference Usage
Editor Select which editor you want the MATLAB desktop to
use when you edit a file:
• MATLAB Editor
• Text editor
If you select Text editor, specify the full path for the
editor application you want to use, such as Emacs or
vi. For example, c:/Applications/Emacs.exe.
7-2
Editor/Debugger Preferences
Preference Usage
Opening files in editor Select On restart reopen files from previous
MATLAB sessions if you want the Editor and the files
it contained during your last MATLAB session to
reopen when you restart MATLAB.
Select Automatically open files when MATLAB
reaches a breakpoint to open a running program file
when MATLAB encounters a breakpoint in that file.
Select Display full path of files in the Editor to
display the full path of files open in the MATLAB
Online Editor and Live Editor. The path displays at the
top of each open file.
Automatic file changes Select Save changes upon clicking away from a
file if you want the Editor and Live Editor to
automatically save changes to a file when you click
away from the file. For the changes to be automatically
saved upon clicking away, you must have already saved
the file at least once.
7-3
7 Editor Preferences
You can change the appearance of the Editor and Live Editor.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Display, and then adjust preference options as described in the table below.
Preference Usage
General display options Select Highlight Current Line and select a color to
highlight the row with the cursor (also called the
caret).
7-4
Editor/Debugger Preferences
Preference Usage
Right-hand text limit Select Show line to display a vertical line with the
specified Color at the specified column (Placement)
in the Editor.
You can specify the size of tabs and indents and details about how tabs behave in the Editor and Live
Editor.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Tab, and then adjust preference options as described in the table below.
In MATLAB Online, these preferences are located under MATLAB > Editor/Debugger > Indenting.
Option Usage
Tab size Specify the amount of space inserted when you press
the Tab key.
When you change the Tab size, it changes the tab size
for existing lines in that file, unless you also select Tab
key inserts spaces.
Indent size Specify the indent size for automatic indenting. To set
automatic indenting preferences, see “Editor/
Debugger Language Preferences” on page 7-5.
Tab key inserts spaces Select to insert a series of spaces when you press the
Tab key. Otherwise, a tab acts as one space whose
length is equal to the Tab size.
Emacs-style Tab key smart indenting Specifies an indenting style similar to the style that the
Emacs editor uses.
7-5
7 Editor Preferences
You can specify how various languages appear in the Editor and Live Editor. MATLAB applies
language preferences based on the file extension of the file that is open.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Language, and then adjust preference options as described in the table below.
In MATLAB Online, these preferences are located under Editor/Debugger > MATLAB Language
and Editor/Debugger > Other Languages.
Preference Usage
Language Select the language for which you want to set preferences.
Syntax highlighting Select Enable syntax highlighting to have the Editor and
Live Editor use different colors for different language
constructs. Then, adjust the colors you want to use for each
language element.
Consider selecting:
7-6
Editor/Debugger Preferences
Preference Usage
Select Wrap comments automatically while typing to
automatically wrap comments at the Maximum column
width value when you type comments in an Editor or Live
Editor document.
• Indent the body of loops within the start and end of the
loop statement.
• Align subsequent lines with lines you indent using tabs or
spaces.
• Indent functions as specified with the Function
indenting format option.
7-7
7 Editor Preferences
Preference Usage
Select an option from Function indenting format (MATLAB
Language only) to specify how functions indent in the Editor
and Live Editor, as follows:
File extensions Add one or more file extensions to associate with the
Language. The preferences you set for that language apply
to all files with the listed extensions.
Code folding enables you to expand and collapse blocks of MATLAB code that you want to hide when
you are not currently working on them.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Code Folding, and then adjust preference options as described in the table below.
For examples and detailed information about code folding, see “Fold Code”.
7-8
Editor/Debugger Preferences
Option Usage
Enable Code Folding Specifies whether you want code folding enabled for
the programming constructs that have their
corresponding Enable check box selected.
Enable Specifies whether you want code folding enabled for
the corresponding Programming Construct.
If you select this option for any construct, but clear the
Enable Code Folding option, the construct will not
have code folding enabled.
Fold Initially Specifies whether the corresponding Programming
Construct displays collapsed (folded) the first time
that you open a MATLAB file.
You can specify if, when, and how you want MATLAB to automatically back up files that are open in
the Editor.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Backup Files, and then adjust preference options as described in the table below.
Backup files preferences do not apply in the Live Editor and are not available in MATLAB Online.
Preference Usage
Automatically create backup files while working Select to have MATLAB automatically save a copy of
in the MATLAB Editor the files you are currently editing.
Save options Save the backup every: n minutes specifies how
often you want MATLAB to save a copy of the file you
are editing.
Save untitled files saves a copy of new, untitled, files
to Untitled.asv.
7-9
7 Editor Preferences
Preference Usage
File name Select the naming convention that you want MATLAB
to use for autosave files. For example:
For more information about automatically creating backup copies of modified files in the Editor, see
“Save and Back Up Code”.
You can quickly format live scripts and functions using autoformatting markup in the Live Editor. You
can enable and disable autoformatting as a whole, or as individual options.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Autoformatting, and then adjust preference options as described in this table.
Preference Usage
Enable autoformatting in Live Editor Select to enable autoformatting options in the Live
Editor. Once enabled, options can then be enabled or
disabled individually.
Text format Select *italic*, **bold** to enable bold and italic
formatting using asterisks (*).
Select _italic_, __bold__ to enable bold and italic
formatting using underscores (_).
Select `monospace`, |monospace| to enable
monospace autoformatting.
Section break Select %%, ***, or --- for section break to enable
inserting section breaks by entering %%, ***, or ---
and then Enter.
7-10
Editor/Debugger Preferences
Preference Usage
Select %% text for section break and heading to
enable inserting section breaks with heading 1 style
headings by entering %%text and then Enter.
Insert Options Select $LaTeX$ for LaTeX equation to enable
converting LaTeX expressions into equations using the
format $LaTeX$.
Select URL for hyperlink to enable converting
internet paths automatically to hyperlinks.
Select <URL> for hyperlink to enable converting
internet paths to hyperlinks using the format <URL>.
Select [Label](URL) for labeled hyperlink to enable
converting internet paths to labeled hyperlinks using
the format [Label](URL).
Select (TM), (SM), (R), and (C) for trademark,
service mark, and copyright symbols to enable
inserting trademark and copyright symbols (™, ℠, ®,
and ©) using the format (TM), (SM), (R), and (C).
Text Style Select #text for title to enable inserting titles using
the format #text.
Select ##text, ###text, or ####text for heading
to enable inserting headings using the format ##text
for heading 1, ###text for heading 2, or ####text
for heading 3.
Select Automatic bulleted lists (*, +, or -) to enable
creating bulleted lists by entering *, +, or - followed
by a space.
Select Automatic numbered lists (1., 2., etc.) to
enable creating numbered lists by entering 1., 2., and
so on, followed by a space.
For more information about autoformatting in the Live Editor, see “Autoformatting”.
You can change how MATLAB suggests and completes names in the Editor, Live Editor, and App
Designer. You also can change whether MATLAB automatically completes block endings, parentheses,
quotes, comments, character vectors, and strings in the Editor, Live Editor, and App Designer.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Automatic Completions, and then adjust preference options as described in this table.
7-11
7 Editor Preferences
Preference Usage
Suggestions and completions Select Show suggestions automatically to
automatically show suggestions as you type in the
Editor, Live Editor, and App Designer. Clear Show
suggestions automatically to show suggestions only
when you press Ctrl+Space or press the Tab key.
7-12
Editor/Debugger Preferences
Preference Usage
Autocomplete on new line
exist("exceptionally_long_file_name.txt")
exist("exceptionally_long" + ...
"_file_name.txt")
• Select Parentheses () to automatically split
parentheses when you press Enter. For example,
place your cursor after the number 10 and the
comma in the command below and press Enter.
plot(x,y,'--gs','LineWidth',2,'MarkerSize',10,'MarkerEd
plot(x,y,'--gs','LineWidth',2,'MarkerSize',10, ...
'MarkerEdgeColor','b')
7-13
7 Editor Preferences
Preference Usage
Autocomplete block endings
You can change the behavior of the Find and Replace dialog box, including disabling wrap-around
search, MATLAB Online.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Find and Replace, and then adjust preference options as described in this table.
Find and replace preferences are not available in installed versions of MATLAB.
Option Usage
Search behavior Select Wrap around to continue searching from the
start of the document when the end of the document is
reached, until the whole document has been searched.
Select Move cursor while typing to move the cursor
to the first result while typing the search phrase. Clear
Move cursor while typing to move the cursor only
after the entire search phrase has been entered.
Select Highlight search results to highlight all
search results in the document.
Search text Select Use selection for initial search text to use
the current selection as the initial search text.
Select Use nearest word for initial search text to
use the word closest to the cursor position as the
initial search text.
Search history Select Persist search and replace history across
sessions to save the search and replace history and
the Find and Replace dialog box state across sessions.
Clear Persist search and replace history across
sessions to disable saving any search and replace
data, including the Find and Replace dialog box state.
7-14
Editor/Debugger Preferences
Option Usage
Position Select Position dialog box above document to
position the Find and Replace dialog box in added
space above the document when the dialog box is
open. When the Find and Replace dialog box is closed,
the space is removed. This added space prevents the
dialog box from covering part of the document when
the dialog box is open.
You can change the size of tabs and indents and the behavior of automatic indenting in the MATLAB
Online Editor and Live Editor. To enable or disable automatic indenting, see “Editor/Debugger
Language Preferences” on page 7-5.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Indenting, and then adjust preference options as described in this table.
Option Usage
Tabs and indents Specify Tab size to determine the amount of space
inserted when you press the Tab key.
When you change the Tab size value, the tab size
changes for existing lines in that file, unless you also
select Tab key inserts spaces.
Specify Indent size for automatic indenting.
Select Tab key inserts spaces to insert a series of
spaces when you press the Tab key. Otherwise, a tab
acts as one space whose length is equal to Tab size.
Select Tab key applies smart indenting to
automatically indent lines according to automatic
indenting preferences when you position the cursor in
a line or select a group of lines and then press the Tab
key.
7-15
7 Editor Preferences
Option Usage
Select Add whitespace to empty lines to indent
empty lines when automatically indenting in the
MATLAB Online Editor and Live Editor by adding
white space to those lines. Clear this option to indent
only lines that are not empty.
Select Remove automatically inserted whitespace
while typing to remove white space added by
automatic indenting while typing in the MATLAB
Online Editor and Live Editor. Clear this option to
leave added white space as is.
You can specify if and when MATLAB Online saves files automatically.
On the Home tab, in the Environment section, click Preferences. Select Editor/Debugger >
Saving, and then adjust preference options as described in this table.
Preference Usage
Autosave options Select Save files periodically to have MATLAB Online
periodically save the files you are currently editing.
In the Every: n minutes field, specify how often you
want MATLAB to save the files you are editing. By
default, MATLAB saves files every 1 minute.
Select Save changes upon clicking away from a
file if you want the Editor and Live Editor to
automatically save changes to a file when you click
away from the file. For the changes to be automatically
saved upon clicking away, you must have already saved
the file at least once.
7-16
Code Analyzer Preferences
In this section...
“Code Analyzer Preferences” on page 7-17
“Search for Messages in the Code Analyzer Preferences” on page 7-18
On the Home tab, in the Environment section, click Preferences. Select Code Analyzer, and
then adjust preference options as described in the table below.
Option Usage
Enabled Integrated Warning and Error Messages Specify whether you want to display Code Analyzer
message indicators, such as the underlining of code
and the message indicator bar, for documents open in
the Editor.
7-17
7 Editor Preferences
Option Usage
Search field Searches the list of Code Analyzer messages that
display below the search field. For details, see “Search
for Messages in the Code Analyzer Preferences” on
page 7-18.
Code Analyzer message settings Select or clear messages to enable or suppress their
appearance in your Editor documents.
Note If you do not have the MATLAB Compiler™ installed, the Code Analyzer preferences pane does
not display the MATLAB Compiler (deployment) messages category.
7-18
Code Analyzer Preferences
In a given category Click the down arrow to the right of the You want to review messages that
search field, click Show Messages in describe coding practices that make it
Category, and then click the category difficult for others to use your code.
you want.
Click the down arrow to the right of the
search field, select Show Messages in
Category, and then select Aesthetics
and Readability.
7-19
7 Editor Preferences
To display Code Analyzer error messages that contain the word variable and are disabled:
1 Click the down arrow in the search field, and then select Show All Errors.
The search field now contains severity:error variable enabled:false. Only the messages
that fulfill those requirements appear in the Preferences pane. To restore the list of all messages,
click the clear search button
.
The Show All Errors and Show Disabled Messages options are not available in MATLAB Online.
See Also
More About
• “Configure Code Analyzer” on page 7-21
• “Check Code for Errors and Warnings Using the Code Analyzer”
7-20
Configure Code Analyzer
Note Changing the severity of a Code Analyzer message does not affect execution. Code is still
executed even if the severity of a check has been set to error. Syntax errors still prevent execution
even if their severity is changed or the message disabled.
This file configures the Code Analyzer checks performed for the resources folder's parent folder
and its subfolders. The configuration is cached at the start of a MATLAB session. The MATLAB Editor
does not automatically get the latest configuration when you add a new configuration file to a
resources folder or update an existing file during a MATLAB session. To refresh the cache, call
matlab.codeanalysis.refreshConfiguration.
Verify that the file is a valid JSON file using the matlab.codeanalysis.validateConfiguration
function.
{
// Configuration File Information
"baseConfiguration" : "closestParentFolder",
"checks":
{
7-21
7 Editor Preferences
"MyFunctionCheck" :
{
"rule":
{
"template": "functionCall",
"functionNames" : "evalin"
},
"severity" : "error",
"messageText" : "Do not use evalin.",
"enabled" : true
},
"MyVariableCheck" :
{
"rule":
{
"template": "variableName",
"variableNames" : ["size", "error", "length", "max", "isa", "nargin" , "numel" , "
},
"severity" : "warning",
"messageText" : "Avoid using function names for variables.",
"enabled" : true
},
"LLMNC" :
{
"severity" : "error",
"limit" : 10,
"enabled": true
},
"FCNOL" :
{
"severity" : "error",
"messageText": "Too many outputs.",
"limit" : 15,
"enabled": true
},
"AGROW" :
{
"severity" : "info",
"messageText" : "Growing array in a loop is not recommended",
"enabled" : false
}
}
}
7-22
Configure Code Analyzer
• "closestParentFolder" (default) — Use the configuration file found in the closest parent
folder. If "baseConfiguration" is not defined, then the "closestParentFolder" setting is
used.
• "factory" — Use the standard MATLAB Code Analyzer configuration.
7-23
7 Editor Preferences
7-24
Configure Code Analyzer
To identify the check ID for checks in a given file, use codeIssues. For a full list of configurable
checks, see “Index of Code Analyzer Checks” on page 7-27.
7-25
7 Editor Preferences
See Also
Apps
Code Analyzer
Objects
codeIssues
Functions
matlab.codeanalysis.validateConfiguration |
matlab.codeanalysis.refreshConfiguration
Related Examples
• “Check Code for Errors and Warnings Using the Code Analyzer”
• “MATLAB Code Analyzer Report”
• “Index of Code Analyzer Checks” on page 7-27
7-26
Index of Code Analyzer Checks
Incomplete Analysis
7-27
7 Editor Preferences
7-28
Index of Code Analyzer Checks
Syntax Errors
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
BADCH Error Invalid text true “MATLAB Operators
character(s). and Special
Characters”
BADCT Error Unicode explicit true
directional
formatting
characters are not
supported.
BADFP Error Invalid floating-point true “Floating-Point
constant. Numbers”
BADHBB Error Invalid digit in true
binary literal.
Supported binary
digits are 0 and 1.
Supported type
suffixes are u8, u16,
u32, u64, and s8,
s16, s32, s64.
BADHBBT Error Binary literal has too true
many digits for
specified type suffix.
BADHBH Error Invalid digit in true
hexadecimal literal.
Supported
hexadecimal digits
are 0-9 and A-F.
Supported type
suffixes are u8, u16,
u32, u64, and s8,
s16, s32, s64.
BADHBHT Error Hexadecimal literal true
has too many digits
for specified type
suffix.
BADNE Error 'Not Equals' is true “MATLAB Operators
spelled ~= in and Special
MATLAB, not !=. Characters”
BADNOT Error Using ~ to ignore a true “MATLAB Operators
value is not and Special
permitted in this Characters”
context.
7-29
7 Editor Preferences
7-30
Index of Code Analyzer Checks
7-31
7 Editor Preferences
7-32
Index of Code Analyzer Checks
7-33
7 Editor Preferences
7-34
Index of Code Analyzer Checks
7-35
7 Editor Preferences
7-36
Index of Code Analyzer Checks
7-37
7 Editor Preferences
7-38
Index of Code Analyzer Checks
7-39
7 Editor Preferences
7-40
Index of Code Analyzer Checks
7-41
7 Editor Preferences
7-42
Index of Code Analyzer Checks
7-43
7 Editor Preferences
7-44
Index of Code Analyzer Checks
7-45
7 Editor Preferences
7-46
Index of Code Analyzer Checks
7-47
7 Editor Preferences
7-48
Index of Code Analyzer Checks
7-49
7 Editor Preferences
Bugs
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
ASSRT Error The first input true
argument to 'assert'
must be a condition.
To always throw an
error, use
'error(msg)' instead.
CFALSE Error This logical true
comparison always
returns false. Did
you mean to use
VAR_NAME to
evaluate function
argument:
VAR_NAME(...VAR_N
AME...)?
CMDAND Error Use 'A & B' or 'A & true
B' to test whether A
and B are both true
in MATLAB.
CMDOR Error Use 'A || B' or 'A | B' true
to test whether
either A or B is true
in MATLAB.
7-50
Index of Code Analyzer Checks
7-51
7 Editor Preferences
7-52
Index of Code Analyzer Checks
7-53
7 Editor Preferences
7-54
Index of Code Analyzer Checks
Custom Checks
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
DAFAF Warning Use of an anonymous true
function is
disallowed by custom
code analyzer
configuration.
DAFBR Warning Use of break true
statement is
disallowed by custom
code analyzer
configuration.
DAFCF Warning Use of command true
syntax to call a
function is
disallowed by custom
code analyzer
configuration.
7-55
7 Editor Preferences
7-56
Index of Code Analyzer Checks
7-57
7 Editor Preferences
Compatibility Considerations
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
ACORR Error Positional syntax for R2024a true autocorr
optional arguments (Econometrics
has been removed Toolbox)
from 'autocorr'. Use
name-value pairs
instead.
ACTXC Warning 'actxcontrol' will be R2019b true actxcontrol
removed in a future
release. There is no
simple replacement
for this.
ACTXL Warning 'actxcontrollist' will R2019b true actxcontrollist
be removed in a
future release. There
is no simple
replacement for this.
ACTXS Warning 'actxcontrolselect' R2019b true actxcontrolselec
will be removed in a t
future release. There
is no simple
replacement for this.
ADTPATH Warning 'path' will be R2018a true
removed in a future
release. Use
'trajectory' instead.
AFADJLM Error 'adaptfilt.adjlms' has R2015a true
S been removed. There
is no simple
replacement for this.
AFAP Error 'adaptfilt.ap' has R2015a true
been removed. With
appropriate code
changes, use
'dsp.AffineProjection
Filter' instead.
7-58
Index of Code Analyzer Checks
7-59
7 Editor Preferences
7-60
Index of Code Analyzer Checks
7-61
7 Editor Preferences
7-62
Index of Code Analyzer Checks
7-63
7 Editor Preferences
7-64
Index of Code Analyzer Checks
7-65
7 Editor Preferences
7-66
Index of Code Analyzer Checks
7-67
7 Editor Preferences
7-68
Index of Code Analyzer Checks
7-69
7 Editor Preferences
7-70
Index of Code Analyzer Checks
7-71
7 Editor Preferences
7-72
Index of Code Analyzer Checks
7-73
7 Editor Preferences
7-74
Index of Code Analyzer Checks
7-75
7 Editor Preferences
7-76
Index of Code Analyzer Checks
7-77
7 Editor Preferences
7-78
Index of Code Analyzer Checks
7-79
7 Editor Preferences
7-80
Index of Code Analyzer Checks
7-81
7 Editor Preferences
7-82
Index of Code Analyzer Checks
7-83
7 Editor Preferences
7-84
Index of Code Analyzer Checks
7-85
7 Editor Preferences
7-86
Index of Code Analyzer Checks
7-87
7 Editor Preferences
7-88
Index of Code Analyzer Checks
7-89
7 Editor Preferences
7-90
Index of Code Analyzer Checks
7-91
7 Editor Preferences
7-92
Index of Code Analyzer Checks
7-93
7 Editor Preferences
7-94
Index of Code Analyzer Checks
7-95
7 Editor Preferences
7-96
Index of Code Analyzer Checks
7-97
7 Editor Preferences
7-98
Index of Code Analyzer Checks
7-99
7 Editor Preferences
7-100
Index of Code Analyzer Checks
7-101
7 Editor Preferences
7-102
Index of Code Analyzer Checks
7-103
7 Editor Preferences
7-104
Index of Code Analyzer Checks
7-105
7 Editor Preferences
7-106
Index of Code Analyzer Checks
7-107
7 Editor Preferences
7-108
Index of Code Analyzer Checks
7-109
7 Editor Preferences
7-110
Index of Code Analyzer Checks
7-111
7 Editor Preferences
7-112
Index of Code Analyzer Checks
7-113
7 Editor Preferences
7-114
Index of Code Analyzer Checks
7-115
7 Editor Preferences
7-116
Index of Code Analyzer Checks
7-117
7 Editor Preferences
7-118
Index of Code Analyzer Checks
7-119
7 Editor Preferences
7-120
Index of Code Analyzer Checks
7-121
7 Editor Preferences
7-122
Index of Code Analyzer Checks
7-123
7 Editor Preferences
7-124
Index of Code Analyzer Checks
7-125
7 Editor Preferences
7-126
Index of Code Analyzer Checks
7-127
7 Editor Preferences
7-128
Index of Code Analyzer Checks
7-129
7 Editor Preferences
7-130
Index of Code Analyzer Checks
7-131
7 Editor Preferences
7-132
Index of Code Analyzer Checks
7-133
7 Editor Preferences
7-134
Index of Code Analyzer Checks
7-135
7 Editor Preferences
7-136
Index of Code Analyzer Checks
7-137
7 Editor Preferences
7-138
Index of Code Analyzer Checks
7-139
7 Editor Preferences
7-140
Index of Code Analyzer Checks
7-141
7 Editor Preferences
7-142
Index of Code Analyzer Checks
7-143
7 Editor Preferences
7-144
Index of Code Analyzer Checks
7-145
7 Editor Preferences
7-146
Index of Code Analyzer Checks
7-147
7 Editor Preferences
7-148
Index of Code Analyzer Checks
7-149
7 Editor Preferences
7-150
Index of Code Analyzer Checks
7-151
7 Editor Preferences
7-152
Index of Code Analyzer Checks
7-153
7 Editor Preferences
7-154
Index of Code Analyzer Checks
7-155
7 Editor Preferences
7-156
Index of Code Analyzer Checks
7-157
7 Editor Preferences
7-158
Index of Code Analyzer Checks
7-159
7 Editor Preferences
7-160
Index of Code Analyzer Checks
7-161
7 Editor Preferences
7-162
Index of Code Analyzer Checks
7-163
7 Editor Preferences
7-164
Index of Code Analyzer Checks
7-165
7 Editor Preferences
7-166
Index of Code Analyzer Checks
7-167
7 Editor Preferences
7-168
Index of Code Analyzer Checks
7-169
7 Editor Preferences
7-170
Index of Code Analyzer Checks
7-171
7 Editor Preferences
7-172
Index of Code Analyzer Checks
7-173
7 Editor Preferences
7-174
Index of Code Analyzer Checks
7-175
7 Editor Preferences
7-176
Index of Code Analyzer Checks
7-177
7 Editor Preferences
7-178
Index of Code Analyzer Checks
7-179
7 Editor Preferences
7-180
Index of Code Analyzer Checks
7-181
7 Editor Preferences
7-182
Index of Code Analyzer Checks
7-183
7 Editor Preferences
7-184
Index of Code Analyzer Checks
7-185
7 Editor Preferences
7-186
Index of Code Analyzer Checks
7-187
7 Editor Preferences
7-188
Index of Code Analyzer Checks
7-189
7 Editor Preferences
Good Practices
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
ADAPPRE Warning Use app as the first true
F argument for
VAR_NAME.
ADMTHDI Warning Use true
NV VAR_NAME(app, ...)
to call this function.
ADPROP Warning Use app.VAR_NAME true
to refer to this
property.
ADPROPL Warning Use app.VAR_NAME true
C to reference a
property of app.
ALIGN Warning This keyword might true
not be aligned with
its matching END on
line VAR_NUMBER.
7-190
Index of Code Analyzer Checks
7-191
7 Editor Preferences
7-192
Index of Code Analyzer Checks
7-193
7 Editor Preferences
7-194
Index of Code Analyzer Checks
7-195
7 Editor Preferences
7-196
Index of Code Analyzer Checks
7-197
7 Editor Preferences
7-198
Index of Code Analyzer Checks
7-199
7 Editor Preferences
7-200
Index of Code Analyzer Checks
7-201
7 Editor Preferences
7-202
Index of Code Analyzer Checks
7-203
7 Editor Preferences
Unset Variables
Unused Constructions
7-204
Index of Code Analyzer Checks
7-205
7 Editor Preferences
Suggested Improvements
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
AGRED Info 'arcgridread' is not R2020a true arcgridread
recommended. With (Mapping Toolbox)
appropriate code
changes, use
'readgeoraster'
instead.
7-206
Index of Code Analyzer Checks
7-207
7 Editor Preferences
7-208
Index of Code Analyzer Checks
7-209
7 Editor Preferences
7-210
Index of Code Analyzer Checks
7-211
7 Editor Preferences
7-212
Index of Code Analyzer Checks
7-213
7 Editor Preferences
7-214
Index of Code Analyzer Checks
7-215
7 Editor Preferences
7-216
Index of Code Analyzer Checks
7-217
7 Editor Preferences
7-218
Index of Code Analyzer Checks
7-219
7 Editor Preferences
7-220
Index of Code Analyzer Checks
7-221
7 Editor Preferences
7-222
Index of Code Analyzer Checks
7-223
7 Editor Preferences
7-224
Index of Code Analyzer Checks
7-225
7 Editor Preferences
7-226
Index of Code Analyzer Checks
7-227
7 Editor Preferences
7-228
Index of Code Analyzer Checks
7-229
7 Editor Preferences
7-230
Index of Code Analyzer Checks
7-231
7 Editor Preferences
7-232
Index of Code Analyzer Checks
7-233
7 Editor Preferences
7-234
Index of Code Analyzer Checks
7-235
7 Editor Preferences
7-236
Index of Code Analyzer Checks
7-237
7 Editor Preferences
7-238
Index of Code Analyzer Checks
Readability Improvements
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
ASGSL Info Assignment to true
variable might be
unnecessary.
CHARTEN Info For readability, true
consider using
'newline' instead of
'char(10)'.
COMNL Info Newline following true
comma acts as a row
separator. Replace
the comma with a
semicolon to make
the row separation
clearer. Alternatively,
use an ellipsis (...) to
continue the current
row on the next line.
DSPSP Info 'disp(sprintf(...))' can true
usually be replaced
by 'fprintf(...\n)'.
DSPSY Info 'display(sprintf(...))' true
can usually be
replaced by
'fprintf(...\n)'.
FLUDLR Info For readability, true
consider using
rot90(x,2) instead of
flipud(fliplr(x)) or
fliplr(flipud(x)).
FVINR Info For readability, add true
Input attribute to the
input arguments
block.
IJCL Warning For improved true
robustness, consider
replacing i and j by
1i.
ISCEL Info Use ISCELL instead true
of comparing the
class to 'cell'.
ISCHR Info Use ISCHAR instead true
of comparing the
class to 'char'.
7-239
7 Editor Preferences
7-240
Index of Code Analyzer Checks
7-241
7 Editor Preferences
Formatting Suggestions
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
NCOMMA Info Best practice is to true
separate output
variables with
commas.
NO4LP Info Parentheses are not true
needed in a FOR
statement.
NOCOMMA Info Extra comma is true
unnecessary.
NOPRT Info Add a semicolon true
after the statement
to hide the output (in
a function).
NOPTS Info Add a semicolon true
after the statement
to hide the output (in
a script).
NOSEMI Info Extra semicolon is true
unnecessary.
PRTCAL Info Add a semicolon true
after the function
call to hide the
output.
7-242
Index of Code Analyzer Checks
Performance Improvements
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
AGROW Info Variable appears to true
change size on every
loop iteration.
Consider
preallocating for
speed.
AND2 Info When both true
arguments are
numeric scalars,
consider replacing &
with & for
performance.
CCAT Info For improved true
performance,
concatenate cell
arrays using []
instead of extracting
cell arrays and
reconstructing them.
CCAT1 Info { A{I} } can usually true
be replaced by A(I)
or A(I)', which can be
much faster.
CLALL Info Using 'clear' with the true
'all' option usually
decreases code
performance and is
often unnecessary.
CLCLS Info Using 'clear' with the true
'classes' option will
decrease code
performance and is
often unnecessary.
CLEAR0A Warning Avoid using 'clear' to true
RGS clear more than
necessary, this
decreases code
performance and is
usually unnecessary.
7-243
7 Editor Preferences
7-244
Index of Code Analyzer Checks
7-245
7 Editor Preferences
7-246
Index of Code Analyzer Checks
7-247
7 Editor Preferences
7-248
Index of Code Analyzer Checks
7-249
7 Editor Preferences
Fixed-Point Messages
7-250
Index of Code Analyzer Checks
System Objects
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
SODEPPR Warning Dependent true
OP properties are not
supported for
MATLAB System
blocks. VAR_NAME
property is not
included on System
block.
SODFLTV Error Invalid initialization true
AL of DiscreteState
property
VAR_NAME.
Initialize property
within a 'resetImpl'
method.
SOINITP Warning Initialize true
ROP DiscreteState
property VAR_NAME
within a 'resetImpl'
method.
SONUMIN Error If 'stepImpl' accepts true
variable number of
inputs, then you
must define a
'getNumInputsImpl'
method.
SONUMOU Error If 'stepImpl' returns true
T variable number of
outputs, then you
must define a
'getNumOutputsImpl
' method.
SORSRVD Warning VAR_NAME property true
NM is a reserved name.
7-251
7 Editor Preferences
Unsupported Features
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
AWTIUD Warning 'awtinvoke' is true javaMethodEDT
unsupported and
might have been
changed without
notice or might be
removed without
notice. With
appropriate code
changes, use
javaMethodEDT
instead.
7-252
Index of Code Analyzer Checks
7-253
7 Editor Preferences
7-254
Index of Code Analyzer Checks
7-255
7 Editor Preferences
Behavior Changes
Check ID Severity Message Message Can Be Disabled? Related
Release Documentation
IDISVAR Warning Variable must be R2017b true “Identifiers without
HIGH explicitly defined explicit declarations
before first use. In might not be treated
some cases, the as variables”
definition was not
required in previous
releases, but it is
now required.
INTRPC Warning 'interp1(...,'cubic')' R2018b true “'cubic' method of
changed in R2020b interp1 performs
to perform cubic cubic convolution”
convolution. To
continue using
shape-preserving
piecewise cubic
interpolation, use
'interp1(...,'pchip')'
instead.
LEGPVPA Warning 'legend' has changed R2018b true legend
IR and might interpret
the name of an
argument as a
legend property
instead of a label. To
include a label with
the same name as a
legend property,
specify the labels
using a cell array or
string array. Refer to
the documentation
for a list of affected
property names.
LENEMP Warning Passing in text with R2021a true “Passing an empty
no characters will label to the legend
omit the object from function omits the
appearing in the entry from the
legend. To revert to legend”
the old behavior, use
a whitespace
character instead of
text with no
characters.
7-256
Index of Code Analyzer Checks
7-257
7 Editor Preferences
7-258
Index of Code Analyzer Checks
7-259
7 Editor Preferences
7-260
Index of Code Analyzer Checks
7-261
7 Editor Preferences
7-262
Index of Code Analyzer Checks
7-263
7 Editor Preferences
7-264
Index of Code Analyzer Checks
7-265
7 Editor Preferences
7-266
Index of Code Analyzer Checks
7-267
7 Editor Preferences
7-268
Index of Code Analyzer Checks
7-269
7 Editor Preferences
7-270
Index of Code Analyzer Checks
7-271
7 Editor Preferences
7-272
Index of Code Analyzer Checks
7-273
7 Editor Preferences
7-274
Index of Code Analyzer Checks
7-275
7 Editor Preferences
7-276
Index of Code Analyzer Checks
7-277
7 Editor Preferences
7-278
Index of Code Analyzer Checks
7-279
7 Editor Preferences
7-280
Index of Code Analyzer Checks
7-281
7 Editor Preferences
7-282
Index of Code Analyzer Checks
7-283
7 Editor Preferences
7-284
Index of Code Analyzer Checks
7-285
7 Editor Preferences
7-286
Index of Code Analyzer Checks
7-287
7 Editor Preferences
7-288
Index of Code Analyzer Checks
7-289
7 Editor Preferences
7-290
Index of Code Analyzer Checks
7-291
7 Editor Preferences
7-292
Index of Code Analyzer Checks
7-293
7 Editor Preferences
7-294
Index of Code Analyzer Checks
7-295
7 Editor Preferences
7-296
Index of Code Analyzer Checks
7-297
7 Editor Preferences
7-298
Index of Code Analyzer Checks
7-299
7 Editor Preferences
7-300
Index of Code Analyzer Checks
7-301
7 Editor Preferences
7-302
Index of Code Analyzer Checks
7-303
7 Editor Preferences
7-304
Index of Code Analyzer Checks
7-305
7 Editor Preferences
7-306
Index of Code Analyzer Checks
7-307
7 Editor Preferences
7-308
Index of Code Analyzer Checks
7-309
7 Editor Preferences
7-310
Index of Code Analyzer Checks
7-311
7 Editor Preferences
7-312
Index of Code Analyzer Checks
7-313
7 Editor Preferences
7-314
Index of Code Analyzer Checks
7-315
7 Editor Preferences
7-316
Index of Code Analyzer Checks
7-317
7 Editor Preferences
7-318
Index of Code Analyzer Checks
7-319
7 Editor Preferences
7-320
Index of Code Analyzer Checks
7-321
7 Editor Preferences
7-322
Index of Code Analyzer Checks
7-323
7 Editor Preferences
7-324
Index of Code Analyzer Checks
7-325
7 Editor Preferences
7-326
Index of Code Analyzer Checks
7-327
7 Editor Preferences
7-328
Index of Code Analyzer Checks
7-329
7 Editor Preferences
7-330
Index of Code Analyzer Checks
7-331
7 Editor Preferences
7-332
Index of Code Analyzer Checks
7-333
7 Editor Preferences
7-334
Index of Code Analyzer Checks
7-335
7 Editor Preferences
7-336
Index of Code Analyzer Checks
7-337
7 Editor Preferences
7-338
Index of Code Analyzer Checks
7-339
7 Editor Preferences
7-340
Index of Code Analyzer Checks
7-341
7 Editor Preferences
7-342
Index of Code Analyzer Checks
7-343
7 Editor Preferences
7-344
Index of Code Analyzer Checks
7-345
7 Editor Preferences
7-346
Index of Code Analyzer Checks
7-347
7 Editor Preferences
7-348
Index of Code Analyzer Checks
7-349
7 Editor Preferences
7-350
Index of Code Analyzer Checks
7-351
7 Editor Preferences
7-352
Index of Code Analyzer Checks
7-353
7 Editor Preferences
7-354
Index of Code Analyzer Checks
7-355
7 Editor Preferences
7-356
Index of Code Analyzer Checks
7-357
7 Editor Preferences
7-358
Index of Code Analyzer Checks
7-359
7 Editor Preferences
7-360
Index of Code Analyzer Checks
7-361
7 Editor Preferences
7-362
Index of Code Analyzer Checks
7-363
7 Editor Preferences
7-364
Index of Code Analyzer Checks
7-365
7 Editor Preferences
7-366
Index of Code Analyzer Checks
7-367
7 Editor Preferences
7-368
Index of Code Analyzer Checks
7-369
7 Editor Preferences
7-370
Index of Code Analyzer Checks
7-371
7 Editor Preferences
7-372
Index of Code Analyzer Checks
7-373
7 Editor Preferences
7-374
Index of Code Analyzer Checks
7-375
7 Editor Preferences
7-376
Index of Code Analyzer Checks
7-377
7 Editor Preferences
7-378
Index of Code Analyzer Checks
7-379
7 Editor Preferences
7-380
Index of Code Analyzer Checks
7-381
7 Editor Preferences
7-382
Index of Code Analyzer Checks
7-383
7 Editor Preferences
7-384
Index of Code Analyzer Checks
7-385
7 Editor Preferences
7-386
Index of Code Analyzer Checks
7-387
7 Editor Preferences
7-388
Index of Code Analyzer Checks
7-389
7 Editor Preferences
7-390
Index of Code Analyzer Checks
7-391
7 Editor Preferences
7-392
Index of Code Analyzer Checks
7-393
7 Editor Preferences
7-394
Index of Code Analyzer Checks
7-395
7 Editor Preferences
7-396
Index of Code Analyzer Checks
7-397
7 Editor Preferences
7-398
Index of Code Analyzer Checks
7-399
7 Editor Preferences
7-400
Index of Code Analyzer Checks
7-401
7 Editor Preferences
7-402
Index of Code Analyzer Checks
7-403
7 Editor Preferences
7-404
Index of Code Analyzer Checks
7-405
7 Editor Preferences
7-406
Index of Code Analyzer Checks
7-407
7 Editor Preferences
7-408
Index of Code Analyzer Checks
7-409
7 Editor Preferences
7-410
Index of Code Analyzer Checks
7-411
7 Editor Preferences
7-412
Index of Code Analyzer Checks
7-413
7 Editor Preferences
7-414
Index of Code Analyzer Checks
7-415
7 Editor Preferences
7-416
Index of Code Analyzer Checks
7-417
7 Editor Preferences
7-418
Index of Code Analyzer Checks
7-419
7 Editor Preferences
7-420
Index of Code Analyzer Checks
7-421
7 Editor Preferences
7-422
Index of Code Analyzer Checks
7-423
7 Editor Preferences
7-424
Index of Code Analyzer Checks
7-425
7 Editor Preferences
7-426
Index of Code Analyzer Checks
7-427
7 Editor Preferences
7-428
Index of Code Analyzer Checks
7-429
7 Editor Preferences
7-430
Index of Code Analyzer Checks
7-431
7 Editor Preferences
7-432
Index of Code Analyzer Checks
7-433
7 Editor Preferences
7-434
Index of Code Analyzer Checks
7-435
7 Editor Preferences
7-436
Index of Code Analyzer Checks
7-437
7 Editor Preferences
7-438
Index of Code Analyzer Checks
7-439
7 Editor Preferences
7-440
Index of Code Analyzer Checks
7-441
7 Editor Preferences
7-442
Index of Code Analyzer Checks
7-443
7 Editor Preferences
7-444
Index of Code Analyzer Checks
7-445
7 Editor Preferences
7-446
Index of Code Analyzer Checks
7-447
7 Editor Preferences
7-448
Index of Code Analyzer Checks
7-449
7 Editor Preferences
7-450
Index of Code Analyzer Checks
7-451
7 Editor Preferences
7-452
Index of Code Analyzer Checks
7-453
7 Editor Preferences
7-454
Index of Code Analyzer Checks
7-455
7 Editor Preferences
7-456
Index of Code Analyzer Checks
7-457
7 Editor Preferences
7-458
Index of Code Analyzer Checks
7-459
7 Editor Preferences
7-460
Index of Code Analyzer Checks
7-461
7 Editor Preferences
7-462
Index of Code Analyzer Checks
7-463
7 Editor Preferences
7-464
Index of Code Analyzer Checks
7-465
7 Editor Preferences
7-466
Index of Code Analyzer Checks
7-467
7 Editor Preferences
7-468
Index of Code Analyzer Checks
7-469
7 Editor Preferences
7-470
Index of Code Analyzer Checks
7-471
7 Editor Preferences
7-472
Index of Code Analyzer Checks
7-473
7 Editor Preferences
7-474
Index of Code Analyzer Checks
7-475
7 Editor Preferences
7-476
Index of Code Analyzer Checks
7-477
7 Editor Preferences
7-478
Index of Code Analyzer Checks
7-479
7 Editor Preferences
7-480
Index of Code Analyzer Checks
See Also
Code Analyzer | codeIssues | fix | checkcode
Related Examples
• “Configure Code Analyzer” on page 7-21
7-481
8
Add-Ons
Add-ons encompass a wide variety of resources, including products, apps, support packages, and
toolboxes. They extend the capabilities of MATLAB with functionality for additional tasks and
applications.
Get Add-Ons
To find and install add-ons, go to the Home tab, and in the Environment section, click the Add-
Ons icon. The Add-On Explorer opens and displays the list of available add-ons.
You must have an active internet connection to get add-ons using the Add-On Explorer.
8-2
Get and Manage Add-Ons
To find add-ons, use the search bar, or browse through the available categories on the left side of the
Add-On Explorer window. Select an add-on from the list to view additional information about it, such
as what files it includes and what documentation is available.
To install an add-on, select it from the list. Then, select from the available install actions. After you
install an add-on, MATLAB manages the MATLAB path for you. So, you can start using it without
adjusting your desktop environment.
For some add-ons, you also can download the files from the Add-on Explorer without installing them.
This is useful if you want to install the add-on on a system without an internet connection. To
download the add-on without installing, select Install > Download Only.
• The add-on is not available for installation through the Add-On Explorer, for example, if you create
a custom add-on yourself or receive one from someone else.
• You downloaded the add-on from the Add-On Explorer without installing it.
• You downloaded the add-on from the File Exchange at MATLAB Central™.
Valid add-on installation files include .mltbx files (for toolboxes), .mlappinstall files (for apps),
and .mlpkginstall files (for hardware support packages). To install an add-on from one of these
files, in the MATLAB Current Folder browser, double-click the file. An installer opens to guide you
through the installation process.
Note Make sure to double-click the installation file in the MATLAB Current Folder browser. Double-
clicking to install the add-on from the system file browser is not supported on all operating systems.
You also can install some add-ons programmatically. For more information, see
matlab.addons.install.
The install location of an add-on depends on its type. MATLAB installs MathWorks products in the
matlabroot folder and hardware support packages in the folder returned by
matlabshared.supportpkg.getSupportPackageRoot. For more information about a specific
support package install location, see the documentation for the package.
MATLAB installs all other add-ons in a default installation folder specific to the platform.
To change the default installation folder, on the Home tab, in the Environment section, select
Preferences > MATLAB > Add-Ons. Then, in the Installation Folder field, specify a folder name
to which you have write access.
8-3
8 Add-Ons
If you change the default installation folder, add-ons installed in the previously selected folder are no
longer accessible from within MATLAB. Changing the default installation folder or customizing
installed add-ons is not supported in MATLAB Online.
Manage Add-Ons
To view and manage installed add-ons, go to the Home tab and select Add-Ons > Manage Add-
Ons. The Add-On Manager displays all add-ons that are installed in the add-ons installation folder, as
well as MATLAB products and hardware support packages.
To manage an individual add-on, click the Options button to the right of the add-on and select from
the available actions.
View Version
To view the currently enabled version of an add-on if it has multiple versions installed, click the
Options button and select Version. MATLAB displays a check mark next to the currently enabled
version. To enable a different version, click it. For more information about installing multiple versions
of an add-on, see matlab.addons.install.
Enable Add-Ons
You can customize your MATLAB environment by enabling or disabling add-ons. You can disable and
enable most add-ons from the MATLAB user community. Disabling and enabling MathWorks products
and support packages is not supported.
To enable or disable an add-on, click the Options button and select or clear the Enabled option. If
an add-on has multiple versions installed, only one version can be enabled. You also can enable or
disable add-ons using the matlab.addons.enableAddon and matlab.addons.disableAddon
functions.
Update Add-Ons
You can update installed add-ons as well as your current installed version of MATLAB using the Add-
On Manager. On the Home tab, select Help > Check for Updates. The Add-On Manager opens with
the Updates tab selected. View and install any available updates.
Run Apps
An app is a self-contained MATLAB program with a user interface. To view and interact with the user
interface after installing the app, run it. Go to the Apps tab and expand the apps gallery by clicking
the down arrow on the far right. Then, navigate to your installed app and click the icon. Custom
apps that you write or receive from someone else appear in the My Apps section. You can run
multiple custom apps concurrently, including multiple instances of the same app.
Get and Manage Add-Ons Using the Add-Ons Panel in MATLAB Online
In MATLAB Online, you can find, install, and manage add-ons using the Add-Ons panel. To open the
Add-Ons panel if it is not open, click the Add-Ons button in the sidebar on the left side of the
8-4
Get and Manage Add-Ons
MATLAB Online desktop. Alternatively, go to the Home tab, and in the Environment section, select
Add-Ons > Add-Ons.
To get add-ons, use the search box at the top of the Add-Ons panel to search for available add-ons or
browse through the list of add-ons in the Recommended for You section. Then, to install an add-on,
select it from the list and click the Install button. You also can browse through the full list of
available add-ons using the Add-On Explorer. To open the Add_on Explorer from the Add-Ons panels,
click the Browse for more link at the bottom of the Recommended for You section.
To manage your add-ons, in the Installed section of the Add-Ons panel, click the Options button to
the right of the add-on that you want to manage. Then, select from the available options. For example,
to view the documentation for an installed add-on, select Open Documentation. To manage your
add-ons using the Add-On Manager, click the Manage Add-Ons link at the bottom of the Installed
section.
To update an installed add-on, click the Update button to the right of the add-on. The Add-Ons panel
displays the Update button next to add-ons with an update available.
8-5
8 Add-Ons
See Also
matlab.addons.install | matlab.addons.installedAddons |
matlab.addons.isAddonEnabled | matlab.addons.enableAddon
Related Examples
• “Package Apps from the MATLAB Toolstrip”
• “Create and Share Toolboxes”
8-6
Configure Add-Ons After Installation
• MATLAB Coder™
• Stateflow®
• Simulink Coder
• Embedded Coder®
• Simulink Test
• C2000™ Microcontroller Blockset — See “Hardware Setup for C2000 Microcontroller Blockset”
(C2000 Microcontroller Blockset).
See Also
Related Examples
• “Get and Manage Add-Ons” on page 8-2
• Supported and Compatible Compilers
8-7
9
Internationalization
The locale of a platform defines the display format for information like time, date, and currency. On
macOS and Linux platforms, the locale also defines the language of your user interface. On Windows
platforms, the display language defines the language of your user interface.
Each platform uses different settings to specify locale and display language. MATLAB uses these
platform-specific settings to determine the desktop display language and the display format for
information like time, date, and currency values within the desktop. This table describes which
settings to set for each platform. For supported operating systems, see System Requirements.
Platform Settings
Windows MATLAB uses multiple settings on Windows platforms.
The Windows display language, user locale, and system locale settings
must all have the same value. Otherwise, you might see garbled text or
incorrectly displayed characters. For instructions on how to change these
settings or install a language pack, refer to your Windows operating
system documentation.
MATLAB uses UTF-8 as its default character encoding and its process-
specific system encoding. You can also set the machine-wide system
encoding to UTF-8 using the Beta: Use Unicode UTF-8 for worldwide
language support option. This option must be used on Windows Server
2019 to avoid garbled text. For all other supported versions of Windows,
this option is optional.
9-2
Set Locale and Display Language
Platform Settings
macOS MATLAB uses the user locale setting on your macOS system to determine
the display language and the display format within the MATLAB desktop.
For instructions on how to change the user locale setting, refer to your
macOS operating system documentation. If the locale that you want to
select is not available, you might first need to install its language pack.
See Also
Related Examples
• “Change the MATLAB Desktop Language” on page 9-9
• “Numbers Display Period for Decimal Point for All Locales” on page 9-7
• “Script Compatibility” on page 9-8
• “Limitations to International Character Support” on page 9-4
9-3
9 Internationalization
• MATLAB C/C++ and Fortran engine library functions and the loadlibrary function cannot find
files located in folder names that contain non 7-bit ASCII characters.
• MATLAB C/C++ and Fortran engine library functions and the calllib function used to call C
library functions cannot convert Unicode-compatible input arguments of type char* to MATLAB
character arrays.
• The matlab.wsdl.createWSDLClient function cannot read non 7-bit ASCII characters in Web
Services Description Language (WSDL) documents.
When you have a file containing text that has characters in a different encoding than that of your
platform, when you save or publish your file, MATLAB displays those characters as garbled text.
See Also
Related Examples
• “Script Compatibility” on page 9-8
• “Set Locale and Display Language” on page 9-2
9-4
Unexpected Behavior on macOS Platforms
MATLAB ignores the LANG environment variable and the Terminal application locale setting.
See Also
Related Examples
• “Set Locale and Display Language” on page 9-2
9-5
9 Internationalization
On Windows Server 2019, you must also set the machine-wide system encoding to UTF-8 using the
Beta: Use Unicode UTF-8 for worldwide language support option to avoid garbled text. For all
other supported versions of Windows, this option is optional.
See Also
Related Examples
• “Set Locale and Display Language” on page 9-2
9-6
Numbers Display Period for Decimal Point for All Locales
MATLAB uses a period for a decimal point, regardless of the format specified by the user locale. For
example, the value of pi can be displayed as 3,1416 or 3.1416, depending on the format used by a
locale. MATLAB always displays 3.1416.
The MATLAB language reserves the use of commas to the cases described in the Symbol Reference
topic.
See Also
More About
• Symbol Reference: Comma
• “Set Locale and Display Language” on page 9-2
9-7
9 Internationalization
Script Compatibility
As of R2020a, plain text files, such as MATLAB scripts or functions, that are encoded using UTF-8
(note that all 7-bit ASCII files are de facto UTF-8 encoded), work seamlessly across all platforms and
all locales. Plain text files created with an earlier version of MATLAB that are not UTF-8 encoded also
work if they were created in the same locale that the current MATLAB is using. Under most
circumstances, MATLAB also operates correctly with plain text files encoded in one of the locale-
specific CJK (Chinese, Japanese, or Korean) encodings.
See Also
Related Examples
• “Set Locale and Display Language” on page 9-2
• “Limitations to International Character Support” on page 9-4
9-8
Change the MATLAB Desktop Language
If the locale or display language settings on your system are set to Japanese, Korean, or Chinese, you
can choose whether to display text in your system language or in English. MATLAB desktop items
(such as dialog boxes, button names, and menu items) and error and warning messages appear in the
language that you select.
1 On the Home tab, in the Environment section, click Preferences and select MATLAB >
General.
2 Select an option for the Desktop language preference.
• On Windows systems, check the display language setting. If the language that you want to
select does not appear in the Windows display language list, you might need to install its
language pack. For instructions on how to view the setting or install a language pack, refer to
the documentation for your Windows system.
The Windows display language, user locale, and system locale settings must all have the same
value to avoid garbled text or incorrectly displayed characters. After changing the display
language, log out and then back into your system for the changes to take effect. After
changing the user locale or system locale settings, restart your system for the changes to take
effect.
• On macOS systems, check the user locale setting. If the locale that you want to select is not
available, you might need to install its language pack. For instructions on how to change the
user locale setting or install a language pack, refer to the documentation for your macOS
system.
9-9
9 Internationalization
• On Linux systems, check the LANG environment variable. For instructions, refer to the
documentation for your Linux system. If you see garbled text or incorrectly displayed
characters, you also might need to install fonts for the selected locale.
3 Restart MATLAB for the preference change to take effect.
Most desktop elements and apps use the language specified by the Desktop language preference.
However, system dialog boxes, such as file selectors or color pickers, use the operating system
display language.
See Also
More About
• “Set Locale and Display Language” on page 9-2
• “Translated Documentation” on page 4-10
9-10
X Servers and International Keyboard Layouts
Suppose you are using a Linux based computer with a German keyboard. Without the XKEYBOARD
extension, Simulink uses the default layout, which is English, and can therefore produce incorrect
characters. MATLAB correctly recognizes the keyboard as German.
If you encounter this issue, try enabling the XKEYBOARD extension, or use an X server that supports
this extension.
9-11
10
MATLAB Online
When you upload a file to MATLAB Online, it is added to your MATLAB Drive. If you add files to your
MATLAB Drive outside of MATLAB Online, you can access those files in MATLAB Online. For more
information about adding files to MATLAB Drive, see “Add Files to Your MATLAB Drive” on page 12-
13.
To download a file from MATLAB Online to your local system, in the Files panel, right-click the file
and select Download.
Preview Files
To preview the contents of a file or folder in MATLAB Online without opening it, in the Files panel,
right-click the file and select Preview. You also can click the Preview button
10-2
Access Files in MATLAB Online
to the
10-3
10 MATLAB Online
See Also
Related Examples
• “Add Files to Your MATLAB Drive” on page 12-13
• “Use MATLAB Online to Access Files in Microsoft OneDrive” on page 11-2
• “Manage Windows in MATLAB Online” on page 10-5
• “MATLAB Online”
10-4
Manage Windows in MATLAB Online
When you open some files, apps, and tools, they open in new windows within the MATLAB Online
environment.
The title bar of a window provides you with the options to pin, collapse, minimize, maximize, and
close a window individually.
• Minimize — Hide a window. At the bottom right of the MATLAB Online environment, the Switch
Windows button indicates the number of minimized windows.
• Maximize — Fit a window to the full size of the MATLAB Online environment.
• Close — Close a window.
To disable the automatic collapse, on the Home tab, in the Environment section, click
Preferences. Select MATLAB > General > Collapsible Windows. Then, clear Enable Auto-
Collapse.
•
To toggle whether a window is minimized, click . Then, select the window to minimize or
restore.
10-5
10 MATLAB Online
•
To minimize all open windows, click . To restore the previously open windows, click .
•
To display a taskbar that lists the minimized windows, click . From the taskbar, toggle whether
a window is minimized by clicking the window title. The taskbar persists until you click or
start a new MATLAB Online session.
See Also
Related Examples
• “Access Files in MATLAB Online” on page 10-2
• “MATLAB Online”
10-6
11
Cloud Storage
1 To open the Connections panel, in the sidebar on the left side of the MATLAB Online desktop,
click the Open more panels button ( ) and select Connections.
2 In the Available Connections section, click the Add button next to OneDrive.
3 Sign in using your Microsoft account credentials.
4 If prompted, grant permission for MATLAB to access the files in your OneDrive account on your
behalf.
Under certain circumstances, an administrator might need to grant permission to connect to your
OneDrive account in MATLAB Online.
You can add only one OneDrive account at any given time. To use different accounts, remove the
existing OneDrive connection and then add a OneDrive connection using the new account.
Once you connect to your OneDrive account, your OneDrive My files folder becomes the current
folder in MATLAB Online and the Files panel displays the list of files and folders stored in that folder.
To open the Files panel if it is not visible, click the Files icon in the sidebar.
Note
11-2
Use MATLAB Online to Access Files in Microsoft OneDrive
• Large files (> 1 GB), can take several seconds to open in MATLAB Online.
• MATLAB Online does not show shared OneDrive folders or shortcuts to files and folders stored in
Sharepoint®.
To view the files and folders for a different connection, in the My Connections section of the
Connections panel, right-click the connection and select Navigate to Connection Name. For
example, to view the files and folders in your MATLAB Drive folder, right-click MATLAB Drive and
select Navigate to MATLAB Drive.
Alternatively, in the Current Folder toolbar, click the drop-down arrow to the left of the current folder
name and select from the available connections.
When you disconnect your OneDrive account, you can no longer access your OneDrive files from
MATLAB Online. Additionally, you might need to manually revoke the permissions that you previously
granted through MATLAB Online. To manually revoke the permissions, use one of these methods:
11-3
11 Cloud Storage
Note Security Considerations: You can choose to restrict user consent for the OneDrive accounts
in your organization. To learn more about managing consent to applications and evaluating consent
requests, see https://learn.microsoft.com/azure/active-directory/manage-apps/
manage-consent-requests.
See Also
Related Examples
• “Access Files in MATLAB Online” on page 10-2
• “MATLAB Online”
11-4
Open in MATLAB Online from GitHub
After creating the links, share them by distributing them to others directly, or by creating Open in
MATLAB Online buttons and including them in a Git README file.
Create Links
You can create links interactively or manually.
Interactively
Manually
To create the link manually, copy the link template below. Then, replace the template parameters with
the information for the repository, as described in the table below.
matlab.mathworks.com/open/github/v1?repo=<authorname>/<reponame>&file=<filename>&project=<projectname>&line=<linenumber>
To omit optional parameters, omit the parameter name and value, as well as the & character that
precedes them. For example, this link template omits the project parameter.
matlab.mathworks.com/open/github/v1?repo=<authorname>/<reponame>&file=<filename>&line=<linenumber>
Note Concurrent access of a Git repository in cloud storage might corrupt the repository.
Share Links
After you create a link, you can distribute it to others, for example, by including it in an email. You
also can share the link by creating an Open in MATLAB Online button and including it in a Git
README file. To create the button, copy the markdown template below, replacing the link parameter
with the link that you created to open the repository in MATLAB Online.
[](<link>)
When you add the markdown to a Git README file, the file shows an Open in MATLAB Online
button, as shown below.
11-5
11 Cloud Storage
See Also
Related Examples
• Create Links for MATLAB Online
• “MATLAB Online”
• “Use Git in MATLAB”
• “Clone Remote Git Repository into New Project”
• “Set Source Control Preferences”
11-6
12
MATLAB Drive
Install Instructions
To install MATLAB Connector, follow these steps:
• From the web — Go to the Connector download page and select an install option. Installing
from the web does not require you to have MATLAB installed.
• From within MATLAB — Click the MATLAB Drive button in the Current Folder toolbar.
If the MATLAB Drive button is not on the Current Folder toolbar, you can add it by right-
clicking the toolbar and selecting Customize. Then, in the MATLAB Toolbar Preferences
Controls section, select Access MATLAB Drive files on this computer and click OK.
MATLAB adds the button to the toolbar.
2 Specify a location for your MATLAB Drive folder and other MATLAB Drive preferences. For more
information, see “MATLAB Drive Preferences and Account Information” on page 12-8.
When configuring the location of your MATLAB Drive folder, these locations are not supported:
When the installer finishes, MATLAB Drive is ready for use. To get started, see “Use MATLAB
Connector to Manage Your Files” on page 12-4.
Uninstall Instructions
Operating Instructions
System
Windows 1 Exit MATLAB Connector.
2 Go to the Control Panel, and select Programs > Uninstall a program.
3 (Optional) If you are on a shared computer, clear your cached account information by
deleting the ServiceHost folder. The default location for this folder is C:\Users
\username\AppData\Local\MathWorks\ServiceHost.
12-2
Install MATLAB Connector for MATLAB Drive
Operating Instructions
System
macOS 1 Exit MATLAB Connector.
2 Open a Terminal window.
3 Navigate to the MATLAB Connector installation folder:
cd ~/Library/Application Support/MathWorks/ServiceHost
4 Run the uninstaller:
./v<VERSION>/mci/InstallMathWorksServiceHost.app/Contents/bin/maci64/UninstallMathWorksServiceHost
VERSION is the MATLAB Connector version, which you can find under Settings in the
Connector; for example, 1.8.0.8.
5 (Optional) If you are on a shared computer, clear your cached account information by
deleting the ServiceHost folder. The default location for this folder is ~/Library/
Application Support/MathWorks/ServiceHost.
Linux 1 Exit MATLAB Connector.
2 Open a Terminal window.
3 Navigate to the MATLAB Connector installation folder:
cd ~/.MathWorks/ServiceHost/<HOSTNAME>
./v<VERSION>/mci/bin/glnxa64/UninstallMathWorksServiceHost.sh
VERSION is the MATLAB Connector version, which you can find under Settings in the
Connector; for example, 1.8.0.8.
5 (Optional) If you are on a shared computer, clear your cached account information by
deleting the ~/.MathWorks/ServiceHost/<HOSTNAME> folder.
See Also
Related Examples
• “Use MATLAB Connector to Manage Your Files” on page 12-4
• “MATLAB Drive Preferences and Account Information” on page 12-8
12-3
12 MATLAB Drive
To install the Connector if it is not already installed on your system, see “Install MATLAB Connector
for MATLAB Drive” on page 12-2.
To start the Connector from within MATLAB, in the Current Folder toolbar, click the MATLAB Drive
button . If you do not see the MATLAB Drive button in the Current Folder toolbar, right-click the
toolbar and select Customize. Then, in the MATLAB Toolbars Preferences Controls section, select
the check box for the MATLAB Drive control and select OK. MATLAB adds the button to the toolbar.
• Windows — In the Start menu, select MATLAB Connector. If you see a security alert when you
start MATLAB Connector, select Allow access to continue.
• macOS — Navigate to ~/Applications in Finder, and double-click MATLAB Connector.
• Linux — Execute ~/bin/MATLABConnector start in a terminal window.
•
Windows — Go to your system notification area, and click the MATLAB Connector icon .
•
macOS — Go to your menu bar and in the status area, click the MATLAB Connector icon .
• Linux — Execute MATLABConnector toggle in a terminal window.
12-4
Use MATLAB Connector to Manage Your Files
MATLAB Connector could not connect to the network. File syncing is paused.
To manage notifications, in the bottom-left corner of the window, click the Settings button . Then,
in the MATLAB Drive tab of the MATLAB Connector Preferences window, you can choose to show
all, recommended, or no notifications.
When you restart the Connector, MATLAB Drive compares an edited file with the same file in cloud
storage. If the content is different, MATLAB Drive renames the local version of the file. The name of
the copied file has the following text appended to the file name:
conflict_copy_machinename_date
12-5
12 MATLAB Drive
To resolve the conflict, compare the two versions, and decide which one you want to keep. You can
merge the changes manually, or delete the version of the file you do not want. If you decide to keep
both versions of the file, you can remove the alert icon by clicking the actions button to the right of
the conflicting file and selecting Dismiss alert.
Issue Description
A file is larger than 5 GB. Smaller files continue to sync.
You exceed your MATLAB Drive Syncing stops. Remove files from your MATLAB Drive to free up
quota. space.
Connection to MATLAB Drive is Syncing stops until the connection is restored.
interrupted.
Filename contains unsupported Other files continue to sync. Rename files that have names with
characters. unsupported characters. Follow the requirements for your
operating system when naming files.
You do not have permission to Syncing does not occur. You are logged in to the computer as a
access files in the MATLAB Drive user who does not have permission to access the local MATLAB
folder. Drive folder. Log in as a user who has permissions to access the
folder, or change the permission on the folder.
To temporarily stop the syncing of your MATLAB Drive files (for example, if you are on a metered or
slow internet connection), you can pause syncing. When syncing is paused, you can continue to
access and edit the local copies of your files in the MATLAB Drive folder on your computer. When you
resume syncing, MATLAB Drive automatically syncs your changes.
To pause syncing, click the Pause syncing button to the right of the status. To resume syncing,
click Resume syncing under the status or the Resume syncing button to the right of the status.
12-6
Use MATLAB Connector to Manage Your Files
To stop MATLAB Connector, click the Exit button in the bottom-left corner of the window. On
Windows, you also can right-click the MATLAB Connector icon in the Windows system notification
area and select Exit. On Linux, you also can execute ~/bin/MATLABConnector stop in a terminal
window.
See Also
Related Examples
• “Access Files in Your MATLAB Drive” on page 12-10
• “MATLAB Drive Preferences and Account Information” on page 12-8
• “Install MATLAB Connector for MATLAB Drive” on page 12-2
12-7
12 MATLAB Drive
Preferences
To set preferences for MATLAB Connector, open the Connector and in the bottom-left corner of the
window, click the Settings button .
Select a tab and adjust the options as described in the following table.
Tab Preference
General Select Start MATLAB Connector at system startup to have MATLAB Connector
Settings start whenever you restart your computer.
Select Help improve MATLAB Connector to send your experience information to
MathWorks.
MathWorks Your Name and E-mail address.
Account
Changing your name and email address is not supported in the MATLAB Connector
preferences. To change your name and email address, edit your MathWorks Account
profile on mathworks.com.
MATLAB Folder Location for MATLAB Drive. This location is specified during the installation
Drive of MATLAB Connector and cannot be changed once it is set.
• All — Display all notifications in the Windows system tray or on the macOS menu
bar. For less interruption to your work, notifications are aggregated and shown
less often.
• Recommended — Display notifications for errors and conflicts only.
• Off — Display no notifications for any sync activity.
Storage Quota
The amount of space you have on MATLAB Drive is limited by the storage quota. Anyone with a
MathWorks Account has a 5 GB storage quota. If you have an eligible MATLAB license that is current
on Software Maintenance Service, your storage quota increases to 20 GB. For more information, see
How much storage do I have in MATLAB Drive?.
For all accounts, when you exceed your storage quota, you cannot perform the following tasks on
MATLAB Drive:
12-8
MATLAB Drive Preferences and Account Information
• Save files
• Upload folders and files
• Move files or folders
• Rename files or folders
• Create folders
If you run out of storage space, delete files to create space. Items in Deleted Files do not count
toward this quota. If you want to restore an item from Deleted Files, you must have the available
storage space.
Deleted Files has its own quota that is equal in size to your MATLAB Drive quota. If your Deleted
Files exceeds this quota, the oldest items are deleted automatically to reduce the storage amount.
This deletion is permanent.
Note If your Software Maintenance Service has lapsed and you remain over storage quota for 12
months, MathWorks reserves the right to delete some files. Additionally, if your account has been
inactive for 24 months and you are not under Software Maintenance Service, MathWorks reserves the
right to delete all your files. MathWorks may also delete files if you are in violation of the SLA or
federal or local laws. In any case, the deletion affects only the files stored in MathWorks cloud.
Your account is considered inactive if you have not signed into any MathWorks applications that use
MATLAB Drive. These applications include, but are not limited to: MATLAB Online, MATLAB Mobile,
MATLAB Connector, and MATLAB Drive online.
See Also
Related Examples
• “Use MATLAB Connector to Manage Your Files” on page 12-4
• “Access Files in Your MATLAB Drive” on page 12-10
12-9
12 MATLAB Drive
MATLAB Drive operates like any other folder, with the significant advantage that files can be synced
with any other MATLAB Drive folder, such as in MATLAB Drive online or on another computer that
uses MATLAB Connector.
To open MATLAB Drive online, from your web browser, navigate to MATLAB Drive and sign in with
your MathWorks credentials. Alternatively, if you have MATLAB Connector installed and running,
open the Connector and click the MATLAB Drive online button in the top-right corner of the
window.
This table describes several actions that you can take on your files and folders in MATLAB Drive
online.
Action Instructions
Preview a file or folder You can preview files including MATLAB code files, text files,
image files, and audio files.
If the file you want to preview is too large or has a file type that is
not supported for previewing online, MATLAB Drive online
prompts you to download the file.
Open a file You can open and edit files in MATLAB Online.
12-10
Access Files in Your MATLAB Drive
Action Instructions
Download a file or folder To download a file or folder from MATLAB Drive online to your
desktop, select the file or folder and then click Download.
MATLAB Drive online saves the file or folder in your system's
default downloads folder. To download multiple files at once, select
the files that you want to download and then click Download.
Downloading multiple folders or a combination of files and folders
at once is not supported.
Alternatively, if MATLAB Connector is running, click the MATLAB Drive folder button from within
the Connector.
12-11
12 MATLAB Drive
In the Current Folder browser, select the MATLAB Drive folder. You also can click the MATLAB
Drive button on the Current Folder toolbar.
Clicking the MATLAB Drive button in the Current Folder toolbar also starts MATLAB Connector if it is
installed but not running. If the MATLAB Drive button is not on the Current Folder toolbar, you can
add it by right-clicking the toolbar and selecting Customize. Then, in the MATLAB Toolbar
Preferences Controls section, select Access MATLAB Drive files on this computer and click OK.
MATLAB adds the button to the toolbar.
To open your MATLAB Drive folder programmatically, use the matlabdrive function.
When you edit a file in the MATLAB Drive folder, you are editing a local copy of the file. MATLAB
Drive updates the files in the cloud with the changes you make locally. Because MATLAB Drive stores
a local copy of files on each computer that has MATLAB Connector installed, you can access these
files when offline or when syncing is paused. File syncing resumes when MATLAB Connector is
running and an internet connection is available, or when syncing is resumed.
See Also
Related Examples
• “Add Files to Your MATLAB Drive” on page 12-13
• “Share Folders Using MATLAB Drive” on page 12-15
• “Restore Deleted Files in MATLAB Drive Online” on page 12-25
• “Use MATLAB Connector to Manage Your Files” on page 12-4
12-12
Add Files to Your MATLAB Drive
• You can add files created or updated while you are working in MATLAB by setting the Current
Folder browser to your MATLAB Drive.
• You can add files created or updated while you are working in MATLAB Online or MATLAB Mobile
to your MATLAB Drive.
If you have MATLAB Connector installed, files on your local MATLAB Drive and MATLAB Drive online
are automatically synced when the Connector is running. The Connector displays the files that have
been synced under Activity. Updates of files greater than 250 MB can take longer to update.
If you do not have MATLAB Connector installed, you can add folders and files to your MATLAB Drive
using MATLAB Drive online with the Upload button (select Files or Folder) or by dragging and
dropping folders and files from the operating system file browser. For either method, empty folders
are not uploaded.
Note
Sync Exclusions
Some small system files, temporary files, and folders created by applications are excluded from
syncing. This exclusion includes the following files:
• desktop.ini
• thumbs.db
• .DS_Store
• Icon\r
Also excluded from syncing are items named in any of the following ways:
• File name begins with ~$ (a tilde and a dollar sign), .~ (a dot and a tilde), or ._ (a dot and an
underscore)
• File names that end with ~ (a tilde)
• File names starting with ~ (a tilde) and ending with the extension .tmp.
• Files with the extension .asv, .autosave, or .mlx.bak
• Folders called slproj
12-13
12 MATLAB Drive
See Also
Related Examples
• “Access Files in Your MATLAB Drive” on page 12-10
• “Restore Deleted Files in MATLAB Drive Online” on page 12-25
• “Use MATLAB Connector to Manage Your Files” on page 12-4
12-14
Share Folders Using MATLAB Drive
When you send someone a personal invitation to a shared folder, they can preview it and add it to
their files. They can also edit its contents if you grant them permission to do so. When you send
someone a view-only link, they can preview it and add it to their files, but not edit it. Previewing and
adding shared folders to your files can only be done in MATLAB Drive online and requires a
MathWorks Account.
To share a folder from MATLAB, you must be running MATLAB R2019b or later, MATLAB Connector
must be running, and the folder you choose to share must be in your MATLAB Drive. If you are
working in MATLAB Online, you do not need MATLAB Connector to share folders since sharing is
always enabled.
Note Security Considerations: If a folder contains symbolic links to other folders on your system,
sharing that folder may grant recipients of the shared folder access to other locations on your system.
MATLAB Drive does not create symbolic links, but it does follow existing symbolic links.
1 Right-click the folder and select Share > Invite Members. If you have already shared the folder
by personal invitation, select Manage Members instead. In MATLAB Drive online, you also can
click the Share button and select from the available options.
In MATLAB Online, you also can select the Preview button to the right of the folder, and in the
Share section, select from the available options.
2 In the Invite section of the invitation, enter the email addresses of the people that you want to
share this folder with. To share the folder with multiple people, enter multiple email addresses
separated by semicolons or commas.
If you have previously shared a folder with others, you also can select from the list of people that
you have recently and frequently shared with. Only people who have previously accepted an
invitation from you are included in the list. To filter the list of suggestions, enter the first name,
last name, or email address of the person you want to share with.
12-15
12 MATLAB Drive
3 Select Can View to share the folder as a read-only folder or Can Edit to allow invited members
to edit its contents. If you want to share the folder with multiple people using different
permissions, send each invitation separately.
4 Optionally, enter a message to include with the invitation.
5 Click Send. MATLAB Drive sends an email to the people you have invited.
Once you personally invite someone to share a folder, you can change their folder permissions from
MATLAB and MATLAB Drive online. For example, if you invite someone to share a folder as a read-
only folder, you can change their permissions to allow them to edit its contents.
To change the folder permissions for an invited member, right-click the shared folder and select
Share > Manage Members. In the Shared With section, next to the address of the invited member,
select a different folder permission. Then, click Save to update the permissions.
In MATLAB Drive online, you also can click the Share button and select Manage Members. In
MATLAB Online, you also can select the Preview button to the right of the folder, and in the Share
section, select Manage Members.
12-16
Share Folders Using MATLAB Drive
Once you personally invite someone to share a folder, you can revoke their access.
To revoke access, right-click the shared folder and select Share > Manage Members. Click the X
next to the name of the member to revoke shared access.
In MATLAB Drive online, you also can click the Share button and select Manage Members. In
MATLAB Online, you also can select the Preview button to the right of the folder, and in the Share
section, select Manage Members.
In MATLAB Online, you also can select the Preview button to the right of the folder, and in the
Share section, select from the available options.
12-17
12 MATLAB Drive
To remove access to a shared folder from a view-only link, right-click the shared folder and select
Share > Manage Link. Click Delete Link and confirm the deletion by clicking Delete.
In MATLAB Drive online, you also can click the Share button and select Manage Link. In MATLAB
Online, you also can select the Preview button to the right of the folder, and in the Share section,
select Manage Link.
Members who gained access to the folder using the link will no longer have access to it, and anyone
who tries to use the link in the future gets an error. Deleting the link does not cause any change in
access to those who received a personal invitation to the shared folder. To change their access, see
“Change Member Permission” on page 12-16.
12-18
Share Folders Using MATLAB Drive
When you are personally invited to a shared folder, you receive an email with a link to the invitation.
Click View Folder in the invitation to open the pending invitation in MATLAB Drive online.
To view all of your pending invitations in MATLAB Drive online, click Shared Content on the left side
of the page.
When the invitation opens, MATLAB Drive online displays a preview of the shared folder. You can
navigate the structure of the shared folder and preview individual files. You must be logged in with
your MathWorks account to preview the folder. To view and open the contents of the folder, and to
edit them if permitted, add the folder to your files.
When you receive a view-only link to a shared folder, open the link to preview it in MATLAB Drive
online. When the preview opens, you can navigate the structure of the folder and preview individual
files. Previewing a folder shared by link does not require a MathWorks account. To view and open the
contents of the folder, add it to your files.
12-19
12 MATLAB Drive
You can also forward the link to others. To get a new copy of the link, click Share Link. In the
Share by Link dialog box, click Copy Link to copy the link to the clipboard.
To view and open the contents of a folder shared with you, and to edit them if permitted, add the
folder to your files. You can add a folder to your files either by creating a shortcut to the shared
folder, or by creating a copy of the shared folder that is only visible and accessible to you.
To create a shortcut to the shared folder, in the MATLAB Drive online folder preview, click the
Add to my Files button and select Add
Shortcut. To create a copy of the shared folder that is only visible and accessible to you, click the
Add to my Files button and select
Copy Folder. MATLAB Drive adds the folder to your files and opens the Files view. You must be
logged in with your MathWorks account to add a shared folder to your files.
If you have MATLAB Connector installed, the Connector syncs the contents of the added shared
folder to your local drive.
12-20
Share Folders Using MATLAB Drive
MATLAB Online and MATLAB Drive online indicate shared folders using the shared folder icon . If
you have MATLAB Connector installed, the Connector indicates shared files in the Activity section by
displaying SHARED below the file name. If you do not have edit permissions for the shared file, the
Connector displays a padlock icon .
If you have edit permissions to a shared folder, you can edit the contents of the files and folders
within that folder. You can edit the files in MATLAB Online, or, if you have MATLAB Connector
installed, you can edit the files on your local drive. As you and other members of the folder make
changes, the Connector keeps the shared folder on your local drive up-to-date.
Warning It is possible that other participants with edit permissions are also editing the same files as
you are. If this occurs, the most recently saved copy overwrites any other saved copies.
You cannot edit a shared file if you do not have edit permissions for the shared folder. If you do not
have edit permissions for a shared file, MATLAB Connector displays a padlock icon below the file
name in the Activity section.
You can move a shared folder to a new location within your MATLAB Drive. If you have edit
permissions to a shared folder, you also can move or rename its contents. You can move or rename
the folder in MATLAB Drive online and, if you have edit permissions to the folder, from MATLAB.
If you have edit permissions for a shared folder, you can move or rename content inside it. When you
move or rename content inside a shared folder, the moved or renamed content is moved or renamed
for all members of the folder.
12-21
12 MATLAB Drive
Note If you move one shared folder into another, the one that you move takes on the permissions of
its new parent. For example, if a member can edit the parent folder, they can now edit the folder that
you move into it.
You can delete a shared folder in your MATLAB Drive. If you have edit permissions to a shared folder,
you can also can delete its contents. You can delete the folder from MATLAB Drive online and, if you
have edit permissions to the folder, from MATLAB.
• MATLAB Drive deletes the folder and its contents only from your MATLAB Drive.
• All others with access to the folder, whether by personal invitation or view-only link, continue to
have access to it.
• The folder no longer counts towards your storage quota.
If you have edit permissions for a shared folder, you can delete content inside it. When you delete
content inside a shared folder:
• MATLAB Drive deletes the content from your MATLAB Drive and for all other members of the
folder.
• The content no longer counts towards your storage quota.
When you delete a shared folder or its contents, MATLAB Drive moves the deleted items to your
Deleted Files folder. You then can choose to permanently delete those items from your MATLAB
Drive.
Note MATLAB Drive permanently deletes content (including shared folders) in your Deleted Files
folder after 30 days or if your Deleted Files folder is over the deleted files storage quota.
If you permanently delete a shared folder from your Deleted Files folder:
• The folder and its contents are permanently deleted only from your MATLAB Drive.
• All others with access to the folder continue to have access to it.
• If you are the owner of the shared folder, then the folder becomes ownerless. When a folder is
ownerless, no new members can gain access to the folder, whether by personal invitation or view-
only link. In addition, MATLAB Drive deletes all pending invitations to access the folder.
• The content is permanently deleted from your MATLAB Drive and for all members of the folder.
You cannot permanently delete content from a shared folder that has active members with edit
permissions to the folder.
12-22
Share Folders Using MATLAB Drive
Sharing Limitations
There are limits on how many folders you can share, how many people you can share each folder
with, and how much data your MATLAB Drive can hold.
You can have up to 100 shared folders in your MATLAB Drive. This total includes folders shared by
you (regardless of whether others have accepted your invitation) and folders shared by others that
you have added to your files. Sub-folders in shared folders are not included in this limit.
The number of people that you can share a folder with depends on whether you have an eligible
MATLAB license that is current on Software Maintenance Service.
• You can share a folder with 1,000 people using a view-only link and with an additional 100 people
using a personal invitation.
• You can share a folder with 10 people using a view-only link and with an additional 10 people
using a personal invitation.
After you have reached your limit for personal invitations you cannot invite others to share that
folder. If a member leaves the shared folder or declines the invitation to access the shared folder,
then you can send additional invitations.
When sharing a folder using a view-only link, when the number of people accessing the link reaches
the folder maximum, others who try to use that link cannot access the folder.
When you add a shared folder to your files, the content of that shared folder is included as part of
your total storage allotment, regardless of whether you have edit or read-only permissions to the
folder. If a member of the folder adds or deletes content, your storage allotment updates accordingly.
• Others with edit permissions can add content to your shared folders, but you cannot.
12-23
12 MATLAB Drive
• You cannot add additional folders to your files or create new invitations or shared links to a folder.
See Also
Related Examples
• “Access Files in Your MATLAB Drive” on page 12-10
• “Add Files to Your MATLAB Drive” on page 12-13
• “Restore Deleted Files in MATLAB Drive Online” on page 12-25
• “Manage Files and Folders” on page 6-35
12-24
Restore Deleted Files in MATLAB Drive Online
To restore content, select the file or folder in Deleted Files, and click Restore.
You can restore content in the Deleted Files folder under the following conditions:
• The file or folder to restore has been in the Deleted Files folder for less than 30 days. (After 30
days or if your Deleted Files has gone over storage quota, content is permanently deleted.)
• You did not permanently delete the content from the Deleted Files folder.
• You have the available storage space in your MATLAB Drive for the restored content.
• You restore an exact item that you deleted. For example, if you deleted an entire folder, you cannot
restore only a single file from that folder — you must restore the entire folder.
Items restored from the Deleted Files folder are returned to their original folder locations.
See Also
Related Examples
• “Add Files to Your MATLAB Drive” on page 12-13
• “Access Files in Your MATLAB Drive” on page 12-10
12-25
13
Post-Installation Tasks
13 Post-Installation Tasks
While you are not required to modify this configuration, the startup accelerator works best if you
coordinate when it runs with your particular MATLAB usage patterns. For example, by default, the
startup accelerator runs at 8:00 a.m. and again at 1:00 p.m. every day, or whenever you log on to
your computer. To take full advantage of the startup accelerator, schedule it to run at a time just
before you typically start MATLAB.
To modify this configuration, use the Windows Task Scheduler. In the Windows Task Scheduler, these
start times are called triggers. You can modify these triggers to customize when the startup
accelerator runs. You can also add triggers, delete triggers, or delete the startup accelerator task
completely. The following section shows how to change when the startup accelerator runs using the
Windows Task Scheduler. For more information about the Task Scheduler, see Windows
documentation.
On the Windows Start menu, search for the phrase “task scheduler” and press Enter.
2 Click Task Scheduler Library in the Console tree to view scheduled tasks and double-click the
name of the startup accelerator to change the configuration.
13-2
Configure the MATLAB Startup Accelerator
3 To change when the task is scheduled to start, click the Trigger tab in the task properties dialog
box. In the list of triggers displayed, select the trigger you want to change, and click Edit.
13-3
13 Post-Installation Tasks
4 To change the time the task is scheduled to run, enter a new time and click OK.
13-4
Configure the MATLAB Startup Accelerator
13-5
14
• “Get Started with the New Desktop for MATLAB (Beta)” on page 14-2
• “Extend MATLAB Using Extension Points (Beta)” on page 14-13
14 New Desktop for MATLAB (Beta)
To try these features, download and install the New Desktop for MATLAB (Beta) add-on from File
Exchange.
Note The new desktop for MATLAB is in beta development and should not be used for development
or production activities. Report all feedback and issues directly to the development team by clicking
the Feedback button directly above the MATLAB Toolstrip.
14-2
Get Started with the New Desktop for MATLAB (Beta)
By default, the colors of figures and apps automatically update to match the selected MATLAB
desktop theme. Starting in R2024a, you can override the desktop theme for an individual figure. To
override the desktop theme of a figure, in the Figures toolstrip, go to the Format tab and select a
theme. You also can change the figure theme programmatically by calling the theme function or
setting the Theme property of the figure to "light" or "dark". For example, this code shows two
ways to set the theme for the figure f to light, regardless of the current desktop theme.
f = figure;
theme(f,"light");
f.Theme = "light";
To override the desktop theme for all figures, in the MATLAB Appearance Preferences page of the
Preferences window, use the Figure Theme option. For example, to display all figures with a light
theme, set the Figure Theme option to Light.
To select the theme for all figures, set the GraphicsTheme setting to "light" or "dark". For
example:
s = settings;
s.matlab.appearance.figure.GraphicsTheme.TemporaryValue = "light";
14-3
14 New Desktop for MATLAB (Beta)
Workspace panel, Files panel, and Command Window, that are docked in that area of the desktop. If
there are no tools docked in an area of the desktop, the sidebar for that area is hidden.
You can use the sidebars to show and hide tools, group tools together, move tools from one location to
another, and open tools that are not in any of the sidebars.
For example, you can use the enhanced figure capabilities to:
• Format figure content interactively — Edit your figure content by using the new Figures toolstrip.
You can use the toolstrip to change text styles and line styles, as well as add items such as titles,
labels, legends, grid lines, arrows, and shapes. To change styles or add an item, select a figure, go
to its Figure or Format tab, and select from the available options.
14-4
Get Started with the New Desktop for MATLAB (Beta)
• Reproduce figure changes — As you interactively change a figure, MATLAB generates code that
represents the changes. You can use this code to reproduce the modified figure. In the Figure tab
of the toolstrip, select Show Code and in the Generated Code panel under the figure, use the
Copy all code button to copy the generated code.
• View all figures and tools in a single area — Independent figures created with the default size and
window state appear as tabs in a single tabbed figure window. You can use the tabs to quickly find
and navigate to a specific figure. In addition, tools to modify the figure (such as the Figures
toolstrip, the Property Inspector, and the Generated Code panel) appear as part of the same
window.
• Compare and arrange figures — View multiple figures at the same time by tiling figures in the
tabbed figure window. Drag tabs to tile figures interactively.
For example, to create a function, type the word function in the Search box. In the list of results,
select the New - Function toolstrip action. MATLAB creates a file containing a basic function
template and opens it in the Editor.
14-5
14 New Desktop for MATLAB (Beta)
Starting in R2024b, you can save live scripts and functions using a plain text file format (.m). Live
scripts saved using the plain text file format behave just like other live scripts. They open in the Live
Editor and can contain code, output, and formatted text. They also can include interactive controls
and tasks.
Note This new file format is available only as part of the new desktop for MATLAB.
14-6
Get Started with the New Desktop for MATLAB (Beta)
The Live Editor uses custom markup to save formatted text, generated output, interactive controls,
and tasks as plain text. The Live Editor saves the custom markup alongside the code and saves any
additional essential data at the bottom of the file.
There are several benefits to saving live scripts using the plain text file format:
• Files open in external code editor — You can open live scripts saved using the plain text file format
in any external text or code editor that supports plain text files.
• Increased transparency — Files saved using the plain text file format do not trigger security
concerns. One exception might be if the live script contains images and plots, which are saved as
Base64 (ASCII-binary) strings in the plain text file.
• Improved integration with source control — You can use external source control tools to compare
and merge live scripts saved using the plain text file format.
To save an existing live script as a new live script using the plain text file format (.m):
1 On the Live Editor tab, in the File section, select Save > Save As.
2 In the dialog box that appears, select MATLAB Code File (*.m) as the Save as type.
3 Enter a filename. To avoid conflicts when running, use a different filename than the original file.
4 Click Save.
To create new live scripts as plain text files by default, go to the Home tab, and in the Environment
section, click Preferences. Select MATLAB > Editor/Debugger and in the Live script format
section, set the Default live script file format to M.
• Some external source control tools have limitations around file size that might prevent the
comparison of live scripts saved using the plain text file format. For the best results, try using
GitHub® Desktop or Visual Studio Code. You also can reduce file size by clearing all output before
submitting your files to source control.
• The help and doc functions might display unexpected content for live functions saved using the
plain text file format.
• When comparing two live scripts or functions saved using the plain text file format, the
Comparison Tool compares the files as plain text files instead of live scripts or functions.
14-7
14 New Desktop for MATLAB (Beta)
• Some programmatic functionality might be unavailable for live scripts and functions saved using
the plain text file format.
Debugger Panel
Use the Debugger panel to manage breakpoints and navigate the function call stack while debugging.
By default, the Debugger panel opens automatically when MATLAB enters debug mode. To open the
Debugger panel manually, go to the Editor or Live Editor tab, and in the Analyze section, click
Debugger. Alternatively, you can open the panel using the Open more panels button ( ) in a
sidebar.
The Breakpoints section in the panel lists the breakpoints in all MATLAB code files. The first four
breakpoints in the section (Pause on Errors, Pause on Warnings, Pause on NaN or Inf, and
Pause on Unsuppressed Output) are error breakpoints. When you enable one of these breakpoints,
MATLAB pauses at any line in any file if the specified error condition occurs. The remaining
breakpoints are grouped by file.
The Function call stack section shows the list of functions MATLAB executed before pausing at the
current line. The functions display in order, with the current script or function in which MATLAB is
paused at the top of the list, and the first called script or function at the bottom of the list. For each
function in the function call stack, there is a corresponding workspace. To view the workspace for a
function in the function call stack, select that function in the list.
14-8
Get Started with the New Desktop for MATLAB (Beta)
For files and folders under Git™ source control, you can use the Branch Manager to manage multiple
local and remote repositories, find and compare commits, and create, delete, and merge branches. To
open the Branch Manager, in the Source Control panel, click the Branch Manager button for the
repository that you want to manage.
You also can view the line-by-line revision history for an entire MATLAB file under Git source control
by using the Blame View option. To show the Blame View, open the file in the Editor. Then, in the gray
area on the left side of the Editor, right-click and select Show Blame View. Alternatively, in the Files
panel, right-click the file and select Source Control > Show Blame View.
14-9
14 New Desktop for MATLAB (Beta)
In the updated project interface, use the Project Settings window to manage all settings for your
project. For example, you can view and edit project details, manage the project path and folder
settings, manage dependencies to projects and packages, automate startup and shutdown actions,
and create labels and custom tasks in a single interface. Project tools, such as Custom Tasks, Project
Checks, Project Upgrade, and Dependency Analyzer, also have simpler interfaces and new
capabilities.
14-10
Get Started with the New Desktop for MATLAB (Beta)
Extension Points
Extend various functionalities of the MATLAB desktop using extension points. For example, you can
use extension points to add items to the Files panel context menu or to the quick access toolbar. To
use extension points, create a JSON-formatted file named extensions.json and add a set of JSON
declarations to the file. Then, to enable your customizations, add extensions.json to the path.
For example, this extensions.json file uses the mw.desktop.quickAccess extension point to
add an item to the quick access toolbar and the mw.desktop.fileBrowser.contextMenu
extension point to add an item to the Files panel context menu.
{
"mw.desktop.quickAccess": {
"items": [
{
"name": "openCustomFunction",
"type": "PushButton",
"text": "Open Custom Function",
"description": "Open my custom function",
"icon": "./icons/Open_16.png",
"command": "openMyFunction"
}]
14-11
14 New Desktop for MATLAB (Beta)
},
"mw.desktop.fileBrowser.contextMenu": {
"customSection": {
"items": [
{
"name": "displayAttributes",
"type": "MenuItem",
"text": "Display File Attributes",
"description": "Tooltip hover information",
"icon": "./icons/Display_16.png",
"command": "displayFileAttributes"
}]
}
}
}
For more information, see “Extend MATLAB Using Extension Points (Beta)” on page 14-13.
To uninstall the new desktop and remove the buttons above the toolstrip, go to the Home tab, and in
the Environment section, select Add-Ons > Add-Ons to open the Add-Ons panel. Click the Options
button to the right of the New Desktop for MATLAB add-on and select Uninstall.
Known Issues
Software development is ongoing for the new desktop for MATLAB. For the most up-to-date list of
known issues, see New Desktop for MATLAB (Beta) on File Exchange.
14-12
Extend MATLAB Using Extension Points (Beta)
You can use these extension points to extend the MATLAB desktop:
Note Extension points are available only as part of the new desktop for MATLAB. The new desktop
for MATLAB is in beta development and should not be used for development or production activities.
For more information, see “Get Started with the New Desktop for MATLAB (Beta)” on page 14-2.
For example, this extensions.json file uses the mw.desktop.quickAccess extension point to
add an item to the quick access toolbar and the mw.desktop.fileBrowser.contextMenu
extension point to add an item to the Files panel context menu.
{
"mw.desktop.quickAccess": {
"items": [
{
"name": "openCustomFunction",
"type": "PushButton",
"text": "Open Custom Function",
"description": "Open my custom function",
"icon": "./open_16.png",
"command": "openMyFunction"
}]
},
"mw.desktop.fileBrowser.contextMenu": {
"customSection": {
"items": [
{
"name": "displayAttributes",
"type": "MenuItem",
14-13
14 New Desktop for MATLAB (Beta)
Create extensions.json
To start extending MATLAB, create a JSON-formatted file named extensions.json and place it in a
folder named resources. You can create more than one extensions.json file, as long as they are
in different resources folders.
For each extension point that you want to use, add a set of JSON declarations to the
extensions.json file.
The extensions.json file should contain a single top-level JSON object. MATLAB extension points
are organized by category in a tree-based hierarchy under the top-level namespace, mw.
JSON uses braces to define objects and refers to objects as collections of name and value pairs.
Because these terms are overloaded in context of MATLAB, this documentation uses the term
"property" instead of "name." JSON uses brackets to define arrays.
Some extension point properties call user-defined MATLAB functions to perform an action. When
creating these functions, specify the required input arguments and no output arguments. Place your
function in a folder on the MATLAB path to make it available.
After you are done creating the extensions.json file, to enable your customizations, add the folder
containing the resources folder and extensions.json to the MATLAB path. To add the folder to
the path, use the addpath function or right-click the folder in the Files panel and select Add to Path
> Selected Folders and Subfolders.
For each custom item that you want add to the Files panel context menu, define an object within the
items array of the mw.desktop.fileBrowser.contextMenu extension point. When adding
multiple custom items, separate each object with a comma.
For example, this extensions.json file contains a set of JSON declarations that adds an item to the
Files panel context menu.
{
"mw.desktop.fileBrowser.contextMenu": {
"customSection": {
14-14
Extend MATLAB Using Extension Points (Beta)
"items": [
{
"name": "displayAttributes",
"type": "MenuItem",
"text": "Display File Attributes",
"icon": "./icons/Display_16.png",
"command": "displayFileAttributes"
}]
}
}
}
To perform an action when a custom item in the Files panel context menu is selected, create a
function that performs the intended action. Then specify the function name as the value of the
command property. Place the function in a folder on the MATLAB path to make it available.
For example, create the function displayFileAttributes, which is referenced by the command
property in the JSON file. MATLAB calls this function when you select the custom
displayAttributes item in the Files panel context menu. When called, the function displays the
file attributes for each selected file in the Files panel.
function displayFileAttributes(selectedFilePaths)
numfiles = length(selectedFilePaths);
for i = 1:numfiles
disp("File attributes for '" + selectedFilePaths(i) + "'")
fileattrib(selectedFilePaths(i))
end
end
To enable your customizations, add the folder containing the resources folder and the
extensions.json file to the path. When the folder is added to the path, a new menu item appears
in the Files panel context menu.
14-15
14 New Desktop for MATLAB (Beta)
When you select the new menu item, MATLAB displays the file attributes for the selected files in the
Files panel within the Command Window.
Name: 'C:\MyWork\stat.m'
archive: 1
system: 0
hidden: 0
directory: 0
UserRead: 1
UserWrite: 1
UserExecute: 1
GroupRead: NaN
GroupWrite: NaN
GroupExecute: NaN
OtherRead: NaN
OtherWrite: NaN
OtherExecute: NaN
For each custom item that you want add to the quick access toolbar, define an object within the
items array of the mw.desktop.quickAccess extension point. When adding multiple custom items,
separate each object with a comma.
14-16
Extend MATLAB Using Extension Points (Beta)
For example, this extensions.json file uses the mw.desktop.quickAccess extension point to
add a push button to the quick access toolbar.
{
"mw.desktop.quickAccess": {
"items": [
{
"name": "openCustomFunction",
"type": "PushButton",
"text": "Open Custom Function",
"description": "Open my custom function",
"icon": "./icons/Open_16.png",
"command": "openMyFunction"
}]
}
}
To perform an action when a custom item in the quick access toolbar is clicked or selected, create a
function that performs the intended action. Then specify the function name as the value of the
command property. Place the function in a folder on the MATLAB path to make it available.
For example, create the function openMyFunction, which is referenced by the command property in
the JSON file. MATLAB calls this function when you click the custom openCustomFunction button
in the quick access toolbar. When called, the function prints a message in the Command Window and
opens myWorkingFile.m in the Editor.
function openMyFunction
disp("Opening 'myWorkingFile.m' in the Editor...")
edit myWorkingFile.m
end
To enable your customizations, add the folder containing the resources folder and the
extensions.json file to the path. When the folder is added to the path, a new button appears in the
quick access toolbar.
When you click the button, the openMyFunction function is called .openMyFunction opens the file
myWorkingFile.m in the Editor and prints this text to the Command Window:
Opening 'myWorkingFile.m' in the Editor...
14-17
14 New Desktop for MATLAB (Beta)
You can customize the icon and label for file types in MATLAB. For each file type that you want to
customize, define an object within the mw.fileTypes.icons and mw.fileTypes.labels
extension points. To specify an icon, specify the object name as the extension of the file type and the
object value as the path to the icon. To specify a label, specify the object name as the extension of the
file type, and the object value as the label text. When adding icons and labels for multiple file types,
separate each object with a comma.
For example, this set of JSON declarations adds a custom icon and label for markdown files (.md) and
SVG files (.svg).
{
"mw.fileTypes.icons": {
"md": "./documentList.svg",
"svg": "./images.svg"
},
"mw.fileTypes.labels": {
"md": "Markdown Documentation File",
"svg": "Support Vector Graphics"
}
}
You can add filename validation for file types. For each file type, define an object within the
mw.fileTypes.filenameValidation extension point. When adding filename validation for
multiple file types, separate each object with a comma.
Within each file type object, define one or more errorRegexPatterns or warningRegexPatterns
objects, separating each object with a comma. Include an errorRegexPatterns or
warningRegexPatterns object for each pattern that you want to validate for. Then, for each
errorRegexPatterns and warningRegexPatterns object, specify a pattern to valid against, any
validation flags, and the error or warning message to display.
For example, this set of JSON declarations adds filename validation for markdown files (.md) to check
whether the name of a markdown file is not empty or too long when the file is created or renamed.
{
"mw.fileTypes.filenameValidation": {
"md": {
"errorRegexPatterns": [{
"pattern": "/^.+$/;",
"flags": "ig",
"errorLabel": "Filename must not be empty"
}],
"warningRegexPatterns": [{
{
"pattern": "/^.{0,125}$",
"flags": "ig",
"warningLabel": "Filename is too long"
}]
}
}
}
14-18
Extend MATLAB Using Extension Points (Beta)
You can create groups of file types in MATLAB using the mw.fileTypes.groups extension point.
Creating groups allows you to customize multiple file types at the same time.
To create a group of file types, define an object within the mw.fileTypes.groups extension point.
Specify the object name as the name of the group that you want to create and the object value as an
array of file type extensions that you want to include in your group. When creating multiple groups,
separate each object with a comma. Then, to use the group to customize multiple file types at the
same time, specify groups.groupname instead of a file type extension.
For example, this set of JSON declarations creates a group for markdown files (.md) and SVG files
(.svg), and then customizes the icon and label for the group.
{
"mw.fileTypes.groups": {
"myfiletype": ["md", "svg"]
},
"mw.fileTypes.icons": {
"groups.myfiletype": "./images.svg"
},
"mw.fileTypes.labels": {
"groups.myfiletype": "My file types"
}
}
To enable your file type customizations, add the folder containing the resources folder and the
extensions.json file to the path. When the folder is added to the path, files with a .md or .svg
extension appear in the Files panel with the icon and label specified in extensions.json. If the
Type column is not visible in the Files panel, go to the top-right corner of the panel, click the Files
actions button , and select Show > Type.
See Also
mw.desktop.addressBar.displayedRoots Extension Point |
mw.desktop.fileBrowser.contextMenu Extension Point | mw.desktop.quickAccess
Extension Point | mw.fileTypes.icons Extension Point | mw.fileTypes.labels
Extension Point | mw.fileTypes.filenameValidation | mw.fileTypes.groups
14-19
14 New Desktop for MATLAB (Beta)
Related Examples
• “Get Started with the New Desktop for MATLAB (Beta)” on page 14-2
14-20