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(outputPath) は、指定された出力 outputPath をレポートに使用します。

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

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

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

入力引数

すべて展開する

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

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

例: "myReport.pdf"

データ型: char | string

`type` — 生成されるレポートの出力タイプ
`"pdf"` (既定値) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

生成されるレポートの出力タイプ。次のいずれかの値として指定します。

"docx" — Microsoft^® Word ドキュメント。
"html" — レポートの HTML ファイル、イメージ、スタイルシート、および JavaScript^® ファイルを含む圧縮ファイルとしてパッケージ化された HTML レポート。解凍されたファイルを含むフォルダーとして HTML レポートを生成するには、PackageType プロパティを "unzipped" または "both" に設定します。
"html-file" — レポートのテキスト、スタイルシート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルで構成される HTML レポート。
"pdf" — PDF ファイル。
"pdfa" — PDF/A ファイル。 (R2025a 以降)

データ型: char | string

`template` — このレポートの書式設定に使用するテンプレートの場所
`[]` | string スカラー | 文字配列

このレポートの書式設定に使用するテンプレートの場所。文字ベクトルまたは string スカラーとして指定します。この引数を使用して、レポートのカスタムテンプレートを指定します。テンプレートタイプはレポートの出力タイプと一致しなければなりません。

データ型: char | string

プロパティ

すべて展開する

`CompileModelBeforeReporting` — レポートする前に Simulink モデルをコンパイルするかどうか
`1` (`true`) (既定値) | `0` (`false`)

レポートする前に Simulink モデルをコンパイルするかどうか。logical の 1 (true) または 0 (false) として指定します。指定に関する詳細は次の通りです。

1 (true) — レポートする前に Simulink モデルをコンパイルします (まだコンパイルされていない場合)。モデルをコンパイルできない場合、レポート生成は終了します。
0 (false) — モデルをコンパイルせずにレポート生成を続行できます。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: logical

`OutputPath` — 生成されたレポートファイルのパス
`[]` (既定値) | 文字ベクトル | string スカラー

生成されたレポートファイルのパス。文字ベクトルまたは string スカラーとして指定します。パスは、ファイルシステムにおけるレポートの出力ドキュメントの場所です。パスは、たとえば "C:/myreports/reportA.docx" のように、絶対パスとすることができます。また、パスは、たとえば "reportA" のように、現在の MATLAB フォルダーに対する相対パスとすることもできます。Type プロパティに対応するファイル拡張子がファイル名にない場合は、レポートドキュメントを閉じると、Report Generator によって適切なファイル拡張子が追加されます。

メモ

MATLAB Drive™ や Microsoft OneDrive™ などのクラウドドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウドドライブ同期ソフトウェアの間でファイルが競合し、次のようなエラーの原因となる場合があります。

Error closing document package: Could not commit changes: removeAll failed: fl:filesystem:AccessDenied: 
C:\Users\jdoe\OneDrive\Documents\MATLAB\reports\temp_FO\stylesheets: Permission denied.

この問題を回避するには、クラウドと同期しないローカルドライブでレポートを生成します。ローカルドライブにレポートを生成し、そのレポートをクラウドドライブにコピーするスクリプトを作成することを検討してください。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Type` — 生成されるレポートの出力タイプ
`"pdf"` (既定値) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

生成されるレポートの出力タイプ。次のいずれかの値として指定します。

"docx" — Microsoft Word ドキュメント。
"html" — レポートの HTML ファイル、イメージ、スタイルシート、および JavaScript ファイルを含む圧縮ファイルとしてパッケージ化された HTML レポート。解凍されたファイルを含むフォルダーとして HTML レポートを生成するには、PackageType プロパティを "unzipped" または "both" に設定します。
"html-file" — レポートのテキスト、スタイルシート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルで構成される HTML レポート。
"pdf" — PDF ファイル。
"pdfa" — PDF/A ファイル。 (R2025a 以降)

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`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"`	`"html-file"` `"pdf"` `"pdfa"` (R2025a 以降)	レポートを単一ファイルとして生成します。

ヒント

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`TemplatePath` — レポートの書式設定に使用するテンプレートの場所
`[]` (既定値) | 文字ベクトル | string スカラー

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Locale` — ロケールまたは言語
`[]` (既定値) | `"af"` | `"ca"` | `"cs"` | ...

ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードで構成される文字ベクトルまたは string スカラーとして指定します。既定値の [] は、システムロケールの言語、たとえば英語システムでは英語を指定します。レポート 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"`	中国語

サポートされていないロケールを指定した場合は、英語バージョンが使用されます。詳細については、Wikipedia Web サイトの List of ISO_639-1 codes を参照してください。

例については、章タイトルの接頭辞のロケールの指定を参照してください。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Debug` — レポートをデバッグモードにするかどうか
`0` (`false`) (既定値) | `1` (`true`)

レポートをデバッグモードにするかどうか。logical の 1 (true) または 0 (false) として指定します。指定に関する詳細は次の通りです。

1 (true) — レポートをデバッグモードにします。レポートの一時ファイルは、レポートフォルダーのサブフォルダーに保存され、レポートを閉じても削除されません。
0 (false) — レポートを通常モードにします。レポートを閉じると一時ファイルが削除されます。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: logical

`Layout` — レポートコンテンツのページレイアウト
`mlreportgen.report.ReportLayout` オブジェクト

レポートコンテンツのページレイアウト。mlreportgen.report.ReportLayout オブジェクトとして指定します。Layout プロパティの既定値は、既定値をもつ mlreportgen.report.ReportLayout オブジェクトです。プロパティ値を変更することで、ページレイアウトをカスタマイズします。例については、横向きのレポートの作成を参照してください。

mlreportgen.report.TitlePage、mlreportgen.report.TableOfContents、および mlreportgen.report.Chapter クラスのオブジェクトの Layout プロパティで指定されたレイアウトオプションは、mlreportgen.report.Report オブジェクトの Layout プロパティで指定されたページレイアウトプロパティをオーバーライドできます。

メモ

Layout プロパティは、PDF と Word のレポートにのみ適用されます。

属性:

`GetAccess`	`public`
`SetAccess`	`protected`

`Document` — DOM ドキュメントオブジェクト
`mlreportgen.dom.Document`

レポートのコンテンツの生成に使用する DOM ドキュメントオブジェクト。mlreportgen.dom.Document オブジェクトとして指定します。

属性:

`GetAccess`	`public`
`SetAccess`	`private`

`Context` — レポートコンテキスト
`containers.Map` オブジェクト

レポートコンテキスト。レポートの現在の節の階層レベルなど、レポート生成用の情報を含む containers.Map オブジェクトとして指定します。

属性:

`GetAccess`	`public`
`SetAccess`	`private`

メソッド

すべて展開する

パブリックメソッド

このクラスは 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`	レポートコンテキストの値の設定
`ispdf`	PDF レポートかどうかのチェック
`isdocx`	Word レポートかどうかのチェック
`ishtml`	Check if multifile HTML report
`ishtmlfile`	単一ファイルの HTML レポートかどうかのチェック

バージョン履歴

R2017b で導入

すべて展開する

R2025a: PDF/A 形式でのレポートの出力

DOM API とレポート API のレポートを PDF/A 形式で出力できます。

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

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

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

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 = Report("My Report","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 = Report("My Report","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 = Report("My Report","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 = Report("My Report","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 クラス

説明

作成

説明

入力引数

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

type — 生成されるレポートの出力タイプ "pdf" (既定値) | "pdfa" | "html" | "html-file" | "docx"

template — このレポートの書式設定に使用するテンプレートの場所 [] | string スカラー | 文字配列

プロパティ

CompileModelBeforeReporting — レポートする前に Simulink モデルをコンパイルするかどうか 1 (true) (既定値) | 0 (false)

属性:

OutputPath — 生成されたレポート ファイルのパス [] (既定値) | 文字ベクトル | string スカラー

属性:

Type — 生成されるレポートの出力タイプ "pdf" (既定値) | "docx" | "html" | "html-file" | "pdfa"

属性:

PackageType — 生成されたファイルに使用するパッケージ化 [] (既定値) | "zipped" | "unzipped" | "both" | "single-file"

属性:

TemplatePath — レポートの書式設定に使用するテンプレートの場所 [] (既定値) | 文字ベクトル | string スカラー

属性:

Locale — ロケールまたは言語 [] (既定値) | "af" | "ca" | "cs" | ...

属性:

Debug — レポートをデバッグ モードにするかどうか 0 (false) (既定値) | 1 (true)

属性:

Layout — レポート コンテンツのページ レイアウト mlreportgen.report.ReportLayout オブジェクト

属性:

Document — DOM ドキュメント オブジェクト mlreportgen.dom.Document

属性:

Context — レポート コンテキスト containers.Map オブジェクト

属性:

メソッド

パブリック メソッド

バージョン履歴

R2025a: PDF/A 形式でのレポートの出力

R2020b: add メソッドは非推奨

参考

トピック

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

`type` — 生成されるレポートの出力タイプ
`"pdf"` (既定値) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

`template` — このレポートの書式設定に使用するテンプレートの場所
`[]` | string スカラー | 文字配列

`CompileModelBeforeReporting` — レポートする前に Simulink モデルをコンパイルするかどうか
`1` (`true`) (既定値) | `0` (`false`)

`OutputPath` — 生成されたレポートファイルのパス
`[]` (既定値) | 文字ベクトル | string スカラー

`Type` — 生成されるレポートの出力タイプ
`"pdf"` (既定値) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

`PackageType` — 生成されたファイルに使用するパッケージ化
`[]` (既定値) | `"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

`TemplatePath` — レポートの書式設定に使用するテンプレートの場所
`[]` (既定値) | 文字ベクトル | string スカラー

`Locale` — ロケールまたは言語
`[]` (既定値) | `"af"` | `"ca"` | `"cs"` | ...

`Debug` — レポートをデバッグモードにするかどうか
`0` (`false`) (既定値) | `1` (`true`)

`Layout` — レポートコンテンツのページレイアウト
`mlreportgen.report.ReportLayout` オブジェクト

`Document` — DOM ドキュメントオブジェクト
`mlreportgen.dom.Document`

`Context` — レポートコンテキスト
`containers.Map` オブジェクト

パブリックメソッド

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