このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

slreportgen.webview.EmbeddedWebViewDocument クラス

名前空間: slreportgen.webview
スーパークラス: slreportgen.webview.WebViewDocument

HTML レポートを生成する Report Generator を作成し、連結されたドキュメントと関連付けられた Web ビューを含める

説明

Report Generator を作成し、生成する HTML レポートに 1 つ以上の Simulink^® モデルのドキュメントと Web ビューを含めて、ドキュメントと Web ビュー間に双方向のハイパーリンクをもたせます。

このクラスには、組み込み Web ビュー レポートを生成するための次の機能があります。

• slreportgen.report.Report オブジェクトに基づく Report Generator。DOM API とレポート API を使用して、ドキュメントの内容を埋めることができます。

• 目次 (TOC)、ドキュメント コンテンツ、Web ビューの 3 つのパネルがある HTML テンプレート

• ドキュメント コンテンツと Web ビューをそれぞれ埋め込むテンプレートのホール。Web ビューのホールは slwebview という名前で、レポートの右側のパネルにあります。ドキュメント コンテンツのホールは Content という名前で、レポートの中央のパネルにあります。

• ドキュメントと Web ビューのホールを埋めるためのメソッド。

• ドキュメント コンテンツと埋め込まれた webview の間に双方向のハイパーリンクを作成するメソッド

• ブラウザーでレポートを開いたときにドキュメントの見出しから目次を生成する JavaScript

• 生成したレポートに Web ビューとして埋め込むモデルとサブシステムを指定できるモデルのエクスポート オプション

• レポートに Web ビューとして埋め込むモデルから要素 (ブロック線図、ブロック、チャートなど) を取得するためのメソッド

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

作成

説明

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,model) は、指定されたモデルの Web ビューを含むレポートを、指定されたファイル名で生成する Report Generator を作成します。ジェネレーターの fill メソッドを使用して Web ビューを生成し、ドキュメントに Web ビューを組み込みます。ジェネレーターの close メソッドを使用して、HTML ドキュメントを含む ZIP ファイルまたはフォルダーとしてドキュメントを出力します。

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

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,{model1,model2,...modeln}) は、出力ドキュメントに組み込まれる Web ビューに指定のモデルを含めるためのジェネレーターを作成します。

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname) は、次の例のようにジェネレーターの ExportOptions プロパティの Diagrams プロパティで指定されたモデルを埋め込むジェネレーターを作成します。

import slreportgen.webview.*
rptgen = EmbeddedWebViewDocument("myDoc");
rptgen.ExportOptions.Diagrams = "myModel";

入力引数

rptname — 出力レポート ファイル、フォルダー、またはそれら両方の名前

文字ベクトル

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

model — エクスポートするモデルの名前

文字ベクトル

生成されるレポートに Web ビューとして組み込むモデルの名前 (文字ベクトルとして指定)。

プロパティ

CurrentHoldID — ドキュメント内の現在のホールの識別子

文字ベクトル | string スカラー

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

ExportOptions — Web ビューのエクスポート オプション

slreportgen.webview.ExportOptions (既定値)

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

IncludeNotes — Web ビューにユーザー メモを含めるかどうか

"off" (既定値) | on/off の logical 値

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

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

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

ForceOverwrite — 既存のレポートを上書きするかどうか

"on" (既定値) | on/off の logical 値

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

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

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

OpenStatus — 生成されるレポートのステータス

"unopened" (既定値) | "opened"

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

OutputPath — ドキュメントの出力ディレクトリのパス

現在の作業ディレクトリ (既定値) | 文字ベクトル | string スカラー

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

PackageType — 出力ドキュメント用に生成されたファイルのパッケージ化

"both" (既定値) | "zipped" | "unzipped"

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

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

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

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

TemplatePath — このレポートの生成に使用するテンプレートのパス

既定の HTML テンプレート (既定値) | 文字ベクトル | string スカラー

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

TitleBarText — HTML ブラウザーのタイトル バーのテキスト

"Simulink Web View - Created by Simulink Report Generator" (既定値) | 文字ベクトル | string スカラー

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

属性:

Dependent

true

NonCopyable

true

データ型: char | string

ValidateLinksAndAnchors — 生成されたドキュメントと Web ビュー間のハイパーリンクの有効性をチェックするかどうか

"on" (既定値) | on/off の logical 値

生成されたドキュメントと Web ビュー間のハイパーリンクの有効性をチェックするかどうか。"on" または "off" として指定するか、数値または logical の 1 (true) または 0 (false) として指定します。"on" の値は true と等価であり、"off" の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

• "on" — 生成されたドキュメントと Web ビュー間のハイパーリンクの有効性をチェックします。

• "off" — 生成されたドキュメントと Web ビュー間のハイパーリンクの有効性をチェックしません。

指定したリンク ターゲットが存在しない場合、または既にリンクが設定されているモデル要素からのリンクを指定した場合は、コマンド ラインで警告を生成します。検証チェックによって、レポートの生成に必要な時間が長くなります。このため、レポートのデバッグ時にのみ、リンクの検証チェックを使用することを検討してください。

メソッド

パブリック メソッド

メソッド	目的
createDiagramTwoWayLink	中央パネルのドキュメント内の位置と、右側のパネルの Web ビュー内のブロック線図との間に双方向のリンクを作成
createElementTwoWayLink	Web ビューでドキュメント パネルの場所とブロック線図の要素の間に双方向のリンクを作成
createDiagramLink	ドキュメント パネルからモデルの Web ビューのブロック線図へのリンクを作成
createElementLink	ドキュメント パネルからモデルの Web ビューの要素へのリンクを作成
fill	組み込み Web ビュー レポートのジェネレーターのホールの埋め込みメソッドを呼び出し、テンプレートのホールを埋める
fillslwebview	テンプレートの slwebview ホールに Web ビューを埋め込む
getExportModels	Web ビューに含めるモデルの名前
getExportDiagrams	Web ビューに含めるブロック線図のパスとハンドル
getExportSimulinkSubSystems	この Web ビューに含まれるサブシステム ブロックのパスとハンドル
getExportStateflowCharts	この Web ビューに含まれる Stateflow® チャートのパスとハンドル
getExportStateflowDiagrams	Stateflow ブロック線図のパスの配列
getReportObject	組み込み Web ビュー レポートのレポート オブジェクトを返す

バージョン履歴

R2017a で導入

R2019b: 目次項目に番号が付かない

R2019b 以降、組み込み Web ビュー レポートの目次項目には番号が付きません。目次で番号付きの項目を作成するには、次を行います。

1. 組み込み Web ビュー レポートの既定のテンプレートを現在のフォルダーにコピーします。

   copyfile(fullfile(matlabroot,...
           "/toolbox/slreportgen/webview/resources/templates/embedded_webview.htmtx"))

2. テンプレートをサブフォルダー myTemplate に解凍します。

   unzipTemplate("embedded_webview.htmtx","myTemplate");

3. myTemplate で、stylesheets サブフォルダーに移動します。root.css ファイルを開き、ol.toc スタイルから次の行を削除します。

   list-style-type: none;

4. root.css ファイルを保存します。

5. 元の圧縮テンプレート ファイルが含まれるフォルダーに移動します。解凍されたテンプレート ファイルを圧縮テンプレート ファイルにパッケージ化します。

   zipTemplate("Newtemplate.htmtx","myTemplate");

6. 組み込み Web ビュー レポートのジェネレーター オブジェクトの TemplatePath プロパティを、新しいテンプレート ファイルのパスと名前に設定します。たとえば、MyEmbeddedWebView が slreportgen.webview.EmbeddedWebViewDocument のサブクラスであるとします。MyEmbeddedWebView オブジェクトの TemplatePath プロパティを設定するコードは次のとおりです。

   rpt = MyEmbeddedWebView(rptName,model);
   rpt.TemplatePath = "NewTemplate.htmtx";

参考

slreportgen.webview.ExportOptions | slreportgen.webview.WebViewDocument

トピック

• 組み込み Web ビュー Report Generator の作成
• 組み込み Web ビュー レポート