compiler.build.WebAppArchiveOptions
Syntax
Description
creates a opts
= compiler.build.WebAppArchiveOptions(AppFile
)WebAppArchiveOptions
object using a MATLAB® app specified using AppFile
. Use the
WebAppArchiveOptions
object as an input to the compiler.build.webAppArchive
function.
creates a opts
= compiler.build.WebAppArchiveOptions(AppFile
,Name,Value
)WebAppArchiveOptions
object with options specified using one or
more name-value arguments. Options include the archive name, additional files to include,
and the output directory.
Examples
Create Web App Archive Options Object
Create a WebAppArchiveOptions
object from a
MATLAB app named Mortgage.mlapp
.
For this example, compile using the file Mortgage.mlapp
located
in
.matlabroot
\examples\matlab\main
appFile = fullfile(matlabroot,'examples','matlab','main','Mortgage.mlapp');
Create a web app options object using the
compiler.build.WebAppArchiveOptions
command.
opts = compiler.build.WebAppArchiveOptions(appFile)
opts =
WebAppArchiveOptions with properties:
ArchiveName: 'Mortgage'
AppFile: 'C:\Program Files\MATLAB\R2023b\examples\matlab\main\Mortgage.mlapp'
AdditionalFiles: {}
AutoDetectDataFiles: on
OutputDir: '.\MortgagewebAppArchive'
Verbose: off
Use the WebAppArchiveOptions
object as an input to the compiler.build.webAppArchive
function to build a web app archive.
buildResults = compiler.build.webAppArchive(opts);
Customize Web App Archive Options Object
Create a WebAppArchiveOptions
object using
name-value arguments.
Create a WebAppArchiveOptions
object using the function file
example.mlapp
. Use name-value arguments to specify the archive name
and output directory, add a MAT-file, and disable automatic detection of data
files.
opts = compiler.build.webAppArchive('example.mlapp',... 'ArchiveName','MyWebApp',... 'OutputDir','D:\Documents\MATLAB\work\WebApps',... 'AdditionalFiles','myvars.mat',... 'AutoDetectDataFiles','off')
opts = WebAppArchiveOptions with properties: ArchiveName: 'MyWebApp' AppFile: 'D:\Documents\MATLAB\work\example.mlapp' AdditionalFiles: {D:\Documents\MATLAB\work\myvars.mat} AutoDetectDataFiles: off OutputDir: 'D:\Documents\MATLAB\work\WebApps' Verbose: off
You can modify the property values of an existing
WebAppArchiveOptions
object using dot notation. For example, enable
verbose output.
opts.Verbose = 'on'
opts = WebAppArchiveOptions with properties: ArchiveName: 'MyWebApp' AppFile: 'D:\Documents\MATLAB\work\example.mlapp' AdditionalFiles: {D:\Documents\MATLAB\work\myvars.mat} AutoDetectDataFiles: off OutputDir: 'D:\Documents\MATLAB\work\WebApps' Verbose: on
Use the WebAppArchiveOptions
object as an input to the compiler.build.webAppArchive
function to build a web app archive.
buildResults = compiler.build.webAppArchive(opts);
Input Arguments
AppFile
— Path to main file
character vector | string scalar
Path to the main file, specified as a row character vector or a string scalar. The
file must be a MATLAB app with the .mlapp
extension. The path can be relative
to the current working directory or absolute.
Example: 'mywebapp.mlapp'
Data Types: char
| string
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: 'Verbose','on'
AdditionalFiles
— Additional files
character vector | string scalar | cell array of character vectors | string array
Additional files and folders to include in the web app archive, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.
Example: 'AdditionalFiles',["myvars.mat","myfunc.m"]
Data Types: char
| string
| cell
ArchiveName
— Name of web app archive
character vector | string scalar
Name of the web app archive, specified as a character vector or a string scalar.
The default value is the file name of AppFile
.
Example: 'ArchiveName','MyWebApp'
Data Types: char
| string
AutoDetectDataFiles
— Flag to automatically include data files
'on'
(default) | on/off logical value
Flag to automatically include data files, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true
, and
'off'
is equivalent to false
. Thus, you can
use the value of this property as a logical value. The value is stored as an on/off
logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then data files that you provide as inputs to certain functions (such asload
andfopen
) are automatically included in the web app archive.If you set this property to
'off'
, then you must add data files to the archive using theAdditionalFiles
property.
Example: 'AutoDetectDataFiles','Off'
Data Types: logical
ObfuscateArchive
— Flag to obfuscate deployable archive
'off'
(default) | on/off logical value
Flag to obfuscate the deployable archive, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true
, and
'off'
is equivalent to false
. Thus, you can
use the value of this property as a logical value. The value is stored as an on/off
logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all.m
files are converted to P-files before packaging. This option is equivalent to usingmcc
with-j
and-s
specified.If you set this property to
'off'
, then the deployable archive is not obfuscated. This is the default behavior.
Example: 'ObfuscateArchive','on'
Data Types: logical
OutputDir
— Path to output directory
character vector | string scalar
Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
The default name of the build folder is the archive name appended with
webAppArchive
.
Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicwebAppArchive'
Data Types: char
| string
SupportPackages
— Support packages
'autodetect'
(default) | 'none'
| string scalar | cell array of character vectors | string array
Support packages to include, specified as one of the following options:
'autodetect'
(default) — The dependency analysis process detects and includes the required support packages automatically.'none'
— No support packages are included. Using this option can cause runtime errors.A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see
compiler.codetools.deployableSupportPackages
.
Example: 'SupportPackages',{'Deep Learning Toolbox Converter for
TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet
Network'}
Data Types: char
| string
| cell
Verbose
— Flag to control build verbosity
'off'
(default) | on/off logical value
Flag to control build verbosity, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true
, and
'off'
is equivalent to false
. Thus, you can
use the value of this property as a logical value. The value is stored as an on/off
logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then the MATLAB command window displays progress information indicating compiler output during the build process.If you set this property to
'off'
, then the command window does not display progress information.
Example: 'Verbose','on'
Data Types: logical
Output Arguments
opts
— Web app archive build options
WebAppArchiveOptions
object
Web app archive build options, returned as a WebAppArchiveOptions
object.
Version History
Introduced in R2020b
See Also
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)