slreportgen.report.Report クラス

名前空間: slreportgen.report

レポートコンテナー

説明

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

メモ

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

slreportgen.report.Report クラスは handle クラスです。

作成

説明

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) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順序で指定できます。

入力引数

すべて展開する

`path` — レポートの出力パス
`untitled.pdf` (既定値) | string | 文字配列

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

`type` — レポートの出力タイプ
`'pdf'` (既定値) | `'html'` | `'html-file'` | `'docx'`

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

`template` — レポートのテンプレート
string | 文字配列

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

プロパティ

すべて展開する

`OutputPath` — レポートドキュメントの出力パス
string | 文字配列

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

メモ

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

`Type` — 出力タイプ
string | 文字ベクトル | `'docx'` | `'pdf'`

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

'HTML' — レポートの HTML ファイル、イメージ、スタイルシート、および JavaScript^® ファイルを含む圧縮ファイルとしてパッケージ化された HTML レポート。
'HTML-FILE' — レポートのテキスト、スタイルシート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルとしての HTML レポート。
'PDF' — PDF ファイル
'DOCX' — Microsoft^® Word ドキュメント

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

`Layout` — ページレイアウトのオプション
`mlreportgen.report.ReportLayout` オブジェクト

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

`Locale` — ロケールまたは言語
`[]` (既定値) | string | 文字配列

ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードとして指定します。既定の [] は、システムロケールの言語、たとえば英語システムでは英語を指定します。レポート API は言語コードを使用して、章タイトルの接頭辞を指定ロケールの言語に変換します。af、ca、cs、da、de、el、en、es、et、eu、fi、fr、hu、id、it、ja、ko、nl、nn、no、pl、pt、ro、ru、sk、sl、sr、sv、tr、uk、xh、および zh の各ロケールに対する変換が提供されています。サポートされていないロケールを指定した場合は、英語バージョンが使用されます。ISO 639-1 コードを参照してください。

`TemplatePath` — テンプレートの場所
string | 文字配列

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

`Document` — 基となる DOM ドキュメントオブジェクト
DOM ドキュメントオブジェクト

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

`Context` — キーと値のコンテナー
マップオブジェクト

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

`Debug` — デバッグモード
`false` (既定値) | `true`

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

`CompileModelBeforeReporting` — Simulink モデルのコンパイル
`true` (既定値) | `false`

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

`PackageType` — 生成されたファイルのパッケージ化
`'zipped'` | `'unzipped'` | `'both'` | `'single-file'`

生成されたファイルに使用されるパッケージ。次の表のいずれかの値として指定します。

値	サポートされるレポートタイプ	説明
`'zipped'`	`'docx'` または `'html'`	`OutputPath` プロパティで指定された場所にレポートを zip ファイルとして生成します。zip ファイルには、ドキュメントのタイプに一致する拡張子 (Word 出力の場合は `docx`、HTML 出力の場合は `htmtx`) が付けられます。たとえば、ドキュメントタイプが `docx` で `OutputPath` が `s:\docs\MyDoc` の場合、出力は `s:\docs\MyDoc.docx` という名前の zip ファイルにパッケージ化されます。
`'unzipped'`	`'docx'` または `'html'`	`OutputPath` プロパティのファイル名をもつフォルダーに、レポートを個別の複数ファイルとして生成します。たとえば、`OutputPath` が `s:\docs\MyDoc` の場合、出力フォルダーは `s:\docs\MyDoc` になります。
`'both'`	`'docx'` または `'html'`	圧縮された出力および圧縮しない出力を生成します。
`'single-file'`	`'pdf'` または `'html-file'`	レポートを単一ファイルとして生成します。

Type プロパティが 'html' の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType を 'unzipped' または 'both' に設定します。生成されたファイルを含むフォルダーで、root.html ファイルを開きます。

メソッド

すべて展開する

パブリックメソッド

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

`open`	レポートを開く
`append`	レポートへのコンテンツの追加
`add`	(非推奨) レポートへのコンテンツの追加
`close`	レポートを閉じて生成する
`rptview`	生成されたレポートファイルをビューアーで開く
`mlreportgen.report.Report.createTemplate`	レポートテンプレートの作成
`mlreportgen.report.Report.customizeReport`	レポートクラスから派生させたクラスの作成
`mlreportgen.report.Report.getClassFolder`	レポートクラス定義ファイルの場所
`getTempPath`	レポートの一時ディレクトリのパス
`generateFileName`	一時レポートファイル名の生成
`getReportLayout`	Current page layout of report
`fill`	レポートテンプレートのホールを埋める
`getContext`	レポートコンテキストの値の取得
`setContext`	Set report context value
`ispdf`	PDF レポートかどうかのチェック
`isdocx`	Word レポートかどうかのチェック
`ishtml`	Check if multifile HTML report
`ishtmlfile`	Check if single-file HTML report

バージョン履歴

R2017b で導入

すべて展開する

R2020b: `add` メソッドは非推奨

R2020b 以降では、以下のレポート API クラスのオブジェクトにコンテンツを追加する場合、add メソッドの代わりに append メソッドを使用してください。

slreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section

mlreportgen.dom.Paragraph オブジェクトなどの DOM API オブジェクトにコンテンツを追加するには、引き続き DOM オブジェクトの append メソッドを使用します。append を使用してレポート API オブジェクトにコンテンツを追加する利点は、DOM API オブジェクトへのコンテンツ追加に使用するものと同じメソッド名が使用されることです。

Report、Chapter、または Section クラスの add メソッドが削除される予定はありません。add メソッドを使用するレポート API プログラムは引き続き動作します。

既存のコードを更新するには、表の例に示すように、メソッド名 add を append に置き換えます。

非推奨	推奨
import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

非推奨

推奨

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = slreportgen.report.Report("myrpt","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
add(sect,para);
add(ch,sect);
add(rpt,ch);

close(rpt);
rptview(rpt);

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = slreportgen.report.Report("myrpt","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
append(sect,para);
append(ch,sect);
append(rpt,ch);

close(rpt);
rptview(rpt);

参考

slreportgen.report.Report クラス

説明

作成

説明

入力引数

path — レポートの出力パス untitled.pdf (既定値) | string | 文字配列

type — レポートの出力タイプ 'pdf' (既定値) | 'html' | 'html-file' | 'docx'

template — レポートのテンプレート string | 文字配列

プロパティ

OutputPath — レポート ドキュメントの出力パス string | 文字配列

Type — 出力タイプ string | 文字ベクトル | 'docx' | 'pdf'

Layout — ページ レイアウトのオプション mlreportgen.report.ReportLayout オブジェクト

Locale — ロケールまたは言語 [] (既定値) | string | 文字配列

TemplatePath — テンプレートの場所 string | 文字配列

Document — 基となる DOM ドキュメント オブジェクト DOM ドキュメント オブジェクト

Context — キーと値のコンテナー マップ オブジェクト

Debug — デバッグ モード false (既定値) | true

CompileModelBeforeReporting — Simulink モデルのコンパイル true (既定値) | false

PackageType — 生成されたファイルのパッケージ化 'zipped' | 'unzipped' | 'both' | 'single-file'

メソッド

パブリック メソッド

バージョン履歴

R2020b: add メソッドは非推奨

参考

トピック

`path` — レポートの出力パス
`untitled.pdf` (既定値) | string | 文字配列

`type` — レポートの出力タイプ
`'pdf'` (既定値) | `'html'` | `'html-file'` | `'docx'`

`template` — レポートのテンプレート
string | 文字配列

`OutputPath` — レポートドキュメントの出力パス
string | 文字配列

`Type` — 出力タイプ
string | 文字ベクトル | `'docx'` | `'pdf'`

`Layout` — ページレイアウトのオプション
`mlreportgen.report.ReportLayout` オブジェクト

`Locale` — ロケールまたは言語
`[]` (既定値) | string | 文字配列

`TemplatePath` — テンプレートの場所
string | 文字配列

`Document` — 基となる DOM ドキュメントオブジェクト
DOM ドキュメントオブジェクト

`Context` — キーと値のコンテナー
マップオブジェクト

`Debug` — デバッグモード
`false` (既定値) | `true`

`CompileModelBeforeReporting` — Simulink モデルのコンパイル
`true` (既定値) | `false`

`PackageType` — 生成されたファイルのパッケージ化
`'zipped'` | `'unzipped'` | `'both'` | `'single-file'`

パブリックメソッド

R2020b: `add` メソッドは非推奨