Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

slreportgen.webview.EmbeddedWebViewDocument クラス

パッケージ: slreportgen.webview
スーパークラス:

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 ビューとして埋め込むモデルから要素 (ブロック線図、ブロック、チャートなど) を取得するためのメソッド

作成

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

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

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

入力引数

すべて展開する

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

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

出力引数

すべて展開する

プロパティ

すべて展開する

ドキュメント内の現在のホールの識別子。文字ベクトルとして格納されます。これは読み取り専用プロパティです。

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

同じ名前の既存のレポートを上書きするかどうかを指定します。True は既存のレポートを上書きします。False は新しい名前でレポートを生成します。

生成されるレポートのステータス。'unopened' または 'opened' です。これは読み取り専用プロパティです。

レポートの出力ディレクトリのパスです。

出力ドキュメントに使用するパッケージ化。次の文字ベクトルのいずれかで指定します。

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

  • 'zipped'.htmx 拡張子をもつ zip ファイルを作成

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

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

生成されたレポートの表示に使用する HTML ブラウザーのタイトル バーに表示するテキスト。既定のテキストは、"Simulink の Web ビュー - Simulink Report Generator で作成" です。

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

メソッド

メソッド

目的

createDiagramTwoWayLink

中央パネルのドキュメント内の位置と、右側のパネルの Web ビュー内のブロック線図との間に双方向のリンクを作成

createElementTwoWayLink

Web ビューでドキュメント パネルの場所とブロック線図の要素の間に双方向のリンクを作成

createDiagramLink

ドキュメント パネルからモデルの Web ビューのブロック線図へのリンクを作成

createElementLink

ドキュメント パネルからモデルの Web ビューの要素へのリンクを作成

fill

組み込み Web ビュー レポートのジェネレーターのホールの埋め込みメソッドを呼び出し、テンプレートのホールを埋める

fillslwebviewテンプレートの slwebview ホールに Web ビューを埋め込む
getExportModelsWeb ビューに含めるモデルの名前
getExportDiagramsWeb ビューに含めるブロック線図のパスとハンドル
getExportSimulinkSubSystemsこの Web ビューに含まれるサブシステム ブロックのパスとハンドル
getExportStateflowChartsこの Web ビューに含まれる Stateflow® チャートのパスとハンドル
getExportStateflowDiagramsStateflow ブロック線図のパスの配列
getReportObject組み込み Web ビュー レポートのレポート オブジェクトを返す

バージョン履歴

R2017a で導入

すべて展開する

R2019b での動作変更