Main Content

compiler.build.WebAppArchiveOptions

Web アプリ アーカイブのビルド オプション

R2020b 以降

説明

opts = compiler.build.WebAppArchiveOptions(AppFile) は、AppFile で指定した MATLAB® アプリを使用して WebAppArchiveOptions オブジェクトを作成します。WebAppArchiveOptions オブジェクトを関数 compiler.build.webAppArchive への入力として使用します。

opts = compiler.build.WebAppArchiveOptions(AppFile,Name,Value) は、名前と値の引数を 1 つ以上使用してオプションが指定された WebAppArchiveOptions オブジェクトを作成します。オプションには、アーカイブ名、含める追加ファイル、出力ディレクトリなどがあります。

すべて折りたたむ

Mortgage.mlapp という名前の MATLAB アプリから WebAppArchiveOptions オブジェクトを作成します。

この例では、matlabroot\examples\matlab\main にあるファイル Mortgage.mlapp を使用してコンパイルします。

appFile = fullfile(matlabroot,'examples','matlab','main','Mortgage.mlapp');

compiler.build.WebAppArchiveOptions コマンドを使用して Web アプリ オプション オブジェクトを作成します。

opts = compiler.build.WebAppArchiveOptions(appFile)
opts = 

  WebAppArchiveOptions with properties:

            ArchiveName: 'Mortgage'
                AppFile: 'C:\Program Files\MATLAB\R2024a\examples\matlab\main\Mortgage.mlapp'
        AdditionalFiles: {}
    AutoDetectDataFiles: on
              OutputDir: '.\MortgagewebAppArchive'
                Verbose: off

WebAppArchiveOptions オブジェクトを関数 compiler.build.webAppArchive への入力として使用して、Web アプリ アーカイブをビルドします。

buildResults = compiler.build.webAppArchive(opts);

名前と値の引数を使用して WebAppArchiveOptions オブジェクトを作成します。

関数ファイル example.mlapp を使用して WebAppArchiveOptions オブジェクトを作成します。名前と値の引数を使用してアーカイブ名と出力ディレクトリを指定し、MAT ファイルを追加して、データ ファイルの自動検出を無効にします。

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

ドット表記を使用して、既存の WebAppArchiveOptions オブジェクトのプロパティ値を変更することができます。たとえば、詳細な出力を有効にします。

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

WebAppArchiveOptions オブジェクトを関数 compiler.build.webAppArchive への入力として使用して、Web アプリ アーカイブをビルドします。

buildResults = compiler.build.webAppArchive(opts);

入力引数

すべて折りたたむ

メイン ファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。ファイルは、拡張子が .mlapp である MATLAB アプリである必要があります。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'mywebapp.mlapp'

データ型: char | string

名前と値の引数

オプションのペアの引数を Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定する必要がありますが、ペアの順序は考慮されません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: 'Verbose','on'

Web アプリ アーカイブに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

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

データ型: char | string | cell

Web アプリ アーカイブの名前。文字ベクトルまたは string スカラーとして指定します。既定値は AppFile のファイル名です。

例: 'ArchiveName','MyWebApp'

データ型: char | string

データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、特定の関数 (loadfopen など) の入力として指定するデータ ファイルは自動的に Web アプリ アーカイブに含められます。

  • このプロパティを 'off' に設定した場合、データ ファイルは AdditionalFiles プロパティを使用してアーカイブに追加しなければなりません。

例: 'AutoDetectDataFiles','Off'

データ型: logical

デプロイ可能なアーカイブを難読化するためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、MATLAB ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-j および -s を指定して mcc を使用するのと等価です。

  • このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。

例: 'ObfuscateArchive','on'

データ型: logical

ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルド フォルダーの既定の名前は、アーカイブ名に webAppArchive を追加したものです。

例: 'OutputDir','D:\Documents\MATLAB\work\mymagicwebAppArchive'

データ型: char | string

含めるサポート パッケージ。次のオプションのいずれかとして指定します。

  • 'autodetect' (既定) — 依存関係の分析プロセスにより、必要なサポート パッケージが自動的に検出され、含められます。

  • 'none' — サポート パッケージは含められません。このオプションを使用すると、ランタイム エラーの原因となる可能性があります。

  • string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポート パッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポート パッケージのリストを表示するには、compiler.codetools.deployableSupportPackages を参照してください。

例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

データ型: char | string | cell

ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、MATLAB コマンド ウィンドウには、ビルド プロセス中のコンパイラ出力を示す進行状況情報が表示されます。

  • このプロパティを 'off' に設定した場合、コマンド ウィンドウには進行状況の情報は表示されません。

例: 'Verbose','on'

データ型: logical

出力引数

すべて折りたたむ

Web アプリ アーカイブのビルド オプション。WebAppArchiveOptions オブジェクトとして返されます。

バージョン履歴

R2020b で導入