slreportgen.webview.WebViewDocument クラス

名前空間: slreportgen.webview

Web ビュー ドキュメント ジェネレーターの作成

このページをすべて展開する

説明

1 つ以上の Simulink® モデルの Web ビューを含む HTML ドキュメントを生成するドキュメント ジェネレーターを作成します。

slreportgen.webview.WebViewDocument クラスは handle クラスです。

作成

説明

wvdocgen = slreportgen.webview.WebViewDocument(docname,model) は、指定されたモデルの Web ビューを含む HTML ドキュメントを指定された場所に生成するドキュメント ジェネレーターを作成します。ジェネレーターの fill メソッドを使用してドキュメントを生成します。

wvdocgen = slreportgen.webview.WebViewDocument(docname,model1,model2,...modeln) は、2 つ以上のモデルが含まれる Web ビューを作成するドキュメント ジェネレーターを作成します。このコンストラクターは、既定の slreportgen.webview.ExportOptions オブジェクトの配列をジェネレーターの ExportOptions プロパティに割り当て、生成されるドキュメントの Web ビューに各モデルを 1 つ含めます。オブジェクトを使用して、エクスポートするモデルにカスタム エクスポート オプションを指定することができます。

例

wvdocgen = slreportgen.webview.WebViewDocument(docname,{model1,model2,...modeln}) は、既定の slreportgen.webview.ExportOptions オブジェクトをジェネレーターの ExportOptions プロパティに割り当てます。これは、エクスポートするすべてのモデルに適用されます。

wvdocgen = slreportgen.webview.WebViewDocument(docname) は、初期状態ではモデルまたはモデルの集合が未指定の Web ビュー ドキュメント ジェネレーターを作成します。ジェネレーターの ExportOptions プロパティの Systems プロパティを使用して、このジェネレーターが生成する Web ビューに含めるモデルを指定します。

入力引数

すべて展開する

このジェネレーターによって生成されたレポートを含む ZIP ファイル、フォルダー、またはそれら両方の名前。このジェネレーターの PackageType プロパティは、生成されるレポートをファイル、フォルダー、またはそれら両方としてパッケージ化するかどうかを指定するために使用します。拡張子を指定する場合は、拡張子を .htmx にしなければなりません。拡張子を指定しない場合は、Report Generator によって .htmx が付加されます。

対話型 HTML Web ビューにエクスポートする Simulink モデルの名前。文字ベクトルとして指定します。

プロパティ

すべて展開する

ドキュメント内の現在のホールの識別子。文字ベクトルまたは string スカラーとして格納されます。

属性:

Dependent
true
NonCopyable
true

データ型: char | string

Web ビューのエクスポート オプション。生成されるレポートにエクスポートする Web ビューに含まれるモデルごと、またはモデルの集合ごとに 1 つの slreportgen.webview.ExportOptions オブジェクトの配列を指定します。ジェネレーター コンストラクターのコンストラクターは、指定したモデルの既定値によってこのプロパティを設定します。生成される Web ビューへのモデルのエクスポートをカスタマイズするには、ExportOptions オブジェクトのプロパティを使用します。たとえば、マスク サブシステムとライブラリ ブロックのブロック線図を含めるため、または含めるかどうかを指定するために追加のモデルを指定できます。

Web ビューにユーザー メモを含めるかどうか。"on" または "off" として指定するか、数値または logical の 1 (true) または 0 (false) として指定します。"on" の値は true と等価であり、"off" の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

  • "on" — Web ビューにユーザー メモを含めます。

  • "off" — Web ビューにユーザー メモを含めません。

同じ名前の既存のレポートを上書きするかどうか。"on" または "off" として指定するか、数値または logical の 1 (true) または 0 (false) として指定します。"on" の値は true と等価であり、"off" の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

  • "on" — 既存のレポートを上書きします。

  • "off" — 新しい名前でレポートを生成します。

生成されるレポートのステータス。"unopened" または "opened" として指定します。

属性:

Dependent
true
NonCopyable
true

データ型: char | string

レポート出力ディレクトリのパス。文字ベクトルまたは string スカラーとして指定します。

属性:

Dependent
true
NonCopyable
true

データ型: char | string

出力ドキュメント用に生成されたファイルのパッケージ化。次のいずれかの値として指定します。

  • "both" — 圧縮および解凍された出力の両方を作成

  • "zipped" — .htmx 拡張子をもつ ZIP ファイルを作成

  • "unzipped" — ファイルのフォルダーを作成

属性:

Dependent
true
NonCopyable
true

データ型: char | string

このレポートの生成に使用する HTML テンプレートへのパス。文字ベクトルまたは string スカラーとして指定します。テンプレートには .htmtx 拡張子が付いています。このプロパティは、既定では HTML テンプレートを指定します。カスタム テンプレートを使用するには、このプロパティをカスタム テンプレートのパスに設定します。

属性:

Dependent
true
NonCopyable
true

データ型: char | string

生成されたレポートの表示に使用する HTML ブラウザーのタイトル バーに表示するテキスト。文字ベクトルまたは string スカラーとして指定します。既定のテキストは "Simulink Web View - Created by Simulink Report Generator" です。

属性:

Dependent
true
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

import slreportgen.webview.*
openExample("f14")
d = WebViewDocument("f14WebView", "f14");
fill(d);
rptview(d);

この例では次を使用します。

ライブ スクリプトを開く

この例のエクスポート オプションを使用して、f14 モデル内に Simulink ライブラリの Band-Limited White Noise ブロックを実装するサブシステム、および sf_car モデル内に Engine ブロックを実装する Stateflow® チャートを表示できます。この例でエクスポート オプションを有効にしていない場合、サブシステムとチャートは、エクスポートされた Web ビュー内で単にブロックとして表示されます。

import slreportgen.webview.*
open_system('f14');
open_system('sf_car');
wvdoc = WebViewDocument(...
    'myWebview','f14','sf_car'); 
opts = wvdoc.ExportOptions;
 
f14Opts = opts(1);
f14Opts.IncludeMaskedSubsystems = true; 
f14Opts.IncludeSimulinkLibraryLinks = true;

sfcarOpts = opts(2);
sfcarOpts.IncludeMaskedSubsystems = true; 

fill(wvdoc)
rptview(wvdoc);

この例では、f14 のルート システムと Aircraft Dynamics Model サブシステムをエクスポートします。

import slreportgen.webview.*
openExample("f14");
wvdoc = WebViewDocument("myWebView", ...
    {"f14", "f14/Aircraft Dynamics Model"});
wvdoc.ExportOptions.SearchScope = "Current";
fill(wvdoc)
rptview(wvdoc);

この例では、f14 のルート システムと Controller サブシステムをエクスポートします。

import slreportgen.webview.*
openExample("f14");
wvdoc = WebViewDocument(...
    "mydoc", "f14/Controller");
wvdoc.ExportOptions.SearchScope = "CurrentAndAbove";
fill(wvdoc)
rptview(wvdoc);

バージョン履歴

R2017a で導入

参考

|