Main Content

compiler.build.WebAppArchiveOptions

Options for building web app archives

Description

example

opts = compiler.build.WebAppArchiveOptions(AppFile) creates a WebAppArchiveOptions object using a MATLAB® app specified using AppFile. Use the WebAppArchiveOptions object as an input to the compiler.build.webAppArchive function.

example

opts = compiler.build.WebAppArchiveOptions(AppFile,Name,Value) creates a 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

collapse all

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\R2021b\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);

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

collapse all

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 comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Verbose','on'

Additional files 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. File paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","myfunc.m"]

Data Types: char | string | cell

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

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 as load and fopen) 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 the AdditionalFiles property.

Example: 'AutoDetectDataFiles','Off'

Data Types: logical

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

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

collapse all

Web app archive build options, returned as a WebAppArchiveOptions object.

Introduced in R2020b