Main Content

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

slreportgen.report.Report クラス

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

レポート コンテナー

説明

slreportgen.report.Report は、Simulink® レポーターと DOM オブジェクトを基にしたレポート用のコンテナーです。このオブジェクトを使用して、テンプレート ライブラリのテンプレートを基に HTML、PDF、または Word のレポートを生成します。

メモ

Simulink レポートを作成するには、mlreportgen.report.Report の代わりにこのタイプのオブジェクトを使用します。このレポートは、Simulink レポーターを使用してコンテンツを生成します。また、MATLAB® レポーターと DOM オブジェクトを使用して Simulink レポートのコンテンツを生成することもできます。

作成

report = slreportgen.report.Report() は、既定のレポート タイプ (PDF) と既定のファイル名 (untitled.pdf) をもつレポート オブジェクト report を返します。

report = slreportgen.report.Report(path) は、指定された出力 path をレポートに使用します。

report = slreportgen.report.Report(path,type) は、指定された type のレポートを作成します。

report = slreportgen.report.Report(path,type,template) は、指定されたテンプレートを使用します。

report = slreportgen.report.Report(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順序で指定できます。

入力引数

すべて展開する

OutputPath プロパティを参照してください。

Type プロパティを参照してください。

TemplatePath プロパティを参照してください。

プロパティ

すべて展開する

レポート ドキュメントの出力パス。string または文字配列として指定します。パスは、レポートの出力ドキュメントが保存されるファイル システム内の場所です。パスは、たとえば 'C:/myreports/reportA.docx''reportA' のように、絶対パスまたは現在の MATLAB フォルダーに対する相対パスとすることができます。Type プロパティに対応するファイル拡張子がファイル名にない場合は、適切なファイル拡張子が追加されます。

メモ

MATLAB Drive™ などのクラウド ドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウド ドライブ同期ソフトウェアの間でファイルが競合し、エラーの原因となる場合があります。このエラーを回避するには、クラウドと同期しないローカル ドライブでレポートを生成します。ローカル ドライブにレポートを生成し、そのレポートをクラウド ドライブにコピーするスクリプトを作成することを検討してください。

出力タイプ。次のいずれかの値として指定します。

  • 'HTML' — レポートの HTML ファイル、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮ファイルとしてパッケージ化された HTML レポート。

  • 'HTML-FILE' — レポートのテキスト、スタイル シート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルとしての HTML レポート。

  • 'PDF' — PDF ファイル

  • 'DOCX'Microsoft® Word ドキュメント

TemplatePath プロパティを使用してテンプレートを指定する場合、Type の値はテンプレート タイプと一致していなければなりません。

このレポートのページ レイアウトのオプション。レポート レイアウト オブジェクトとして指定します。mlreportgen.report.ReportLayout を参照してください。

ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードとして指定します。既定の [] は、システム ロケールの言語、たとえば英語システムでは英語を指定します。レポート API は言語コードを使用して、章タイトルの接頭辞を指定ロケールの言語に変換します。afcacsdadeeleneseteufifrhuiditjakonlnnnoplptroruskslsrsvtrukxh、および zh の各ロケールに対する変換が提供されています。サポートされていないロケールを指定した場合は、英語バージョンが使用されます。ISO 639-1 コードを参照してください。

レポートの書式設定に使用するテンプレートの場所。string または文字配列として指定します。このプロパティを使用して、このレポートのカスタム テンプレートを指定します。

この読み取り専用プロパティは、レポートのコンテンツの生成に使用される mlreportgen.dom.Document です。

この読み取り専用プロパティは、レポートの現在の節の階層レベルなど、レポート生成用の情報を含む containers.Map オブジェクトです。

デバッグ モード。logical として指定します。Debugtrue に設定すると、レポートの一時ファイルがレポート フォルダーのサブフォルダーに保存されます。デバッグ モードでは、レポートを閉じてもこれらのファイルは削除されません。

レポートする前に Simulink モデルをコンパイルするかどうか。logical として指定します。このプロパティが true で、モデルがまだコンパイルされていない場合、このモデルについてレポートするレポーターをこのレポートに追加すると、モデルがコンパイルされます。モデルをコンパイルできない場合、レポート生成は終了します。このプロパティが false の場合、モデルをコンパイルせずにレポート生成が続行します。

メソッド

このクラスは MATLAB バージョンと同じメソッドを使用します。クラス名で mlreportgen を使用する代わりに、slreportgen を使用します。メソッドのリストは、mlreportgen.report.Report を参照してください。

コピーのセマンティクス

ハンドル。ハンドル クラスがコピー操作に与える影響の詳細については、オブジェクトのコピーを参照してください。

バージョン履歴

R2017b で導入

すべて展開する