mlreportgen.report.Report クラス

名前空間: mlreportgen.report

レポートコンテナー

説明

mlreportgen.report.Report クラスのオブジェクトは、レポーターと MATLAB^® および DOM のオブジェクトで構成されるレポートのコンテナーです。mlreportgen.report.Report オブジェクトを使用して、テンプレートライブラリのテンプレートに基づいた HTML、PDF、または Word レポートを生成します。

メモ

Simulink^® または Stateflow^® のコンテンツを含むレポートを作成するには、slreportgen.report.Report (Simulink Report Generator) クラスを使用します。

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

クラス属性

HandleCompatible true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

report = mlreportgen.report.Report は、既定のプロパティ値でレポートコンテナーオブジェクトを返します。

report = mlreportgen.report.Report(path) は、OutputPath プロパティを path に設定します。

report = mlreportgen.report.Report(path,type) は、さらにTypeプロパティを type に設定します。

例

report = mlreportgen.report.Report(path,type,template) は、さらに TemplatePath プロパティを template に設定します。

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

プロパティ

すべて展開する

`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"`

出力タイプ。以下のいずれか 1 つを値として指定します。

"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` — デバッグモード
`false` または `0` (既定値) | `true` または `1`

デバッグモード。数値または logical の 1 (true) または 0 (false) として指定します。Debug を true または 1 に設定する場合、レポートの一時ファイルはレポートフォルダーのサブフォルダーに保存されます。レポートを閉じても削除されることはありません。

属性:

`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`

メソッド

すべて展開する

パブリックメソッド

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

例

すべて折りたたむ

レポートの作成

ライブスクリプトを開く

レポート API を使用してレポートを作成します。

完全修飾クラス名を使用せずに済むよう、DOM およびレポートの API 名前空間をインポートします。

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

レポートコンテナーを作成します。

rpt = Report('My Report','pdf');

レポートにタイトルページ、目次、および章を追加します。この章には 2 つの節があり、それぞれの節はイメージを含みます。

append(rpt,TitlePage(Title='My Report'));
append(rpt,TableOfContents);
ch = Chapter('Images');
append(ch,Section(Title='Boeing 747',...
    Content=Image(which('b747.jpg'))));
append(ch,Section(Title='Peppers',...
    Content=Image(which('peppers.png'))));
append(rpt,ch);
close(rpt);
rptview(rpt);

横向きのレポートの作成

レポート API を使用して、横向きのレポートを作成します。

長い完全修飾クラス名を使用せずに済むよう、レポート API 名前空間をインポートします。

import mlreportgen.report.*

レポートコンテナーを作成します。Layout プロパティに割り当てられた mlreportgen.report.ReportLayout オブジェクトで、Landscape プロパティを true に設定します。

rpt = Report("myreport","pdf");
rpt.Layout.Landscape = true;

レポートにコンテンツを追加します。レポートを生成して表示します。

append(rpt,TitlePage(Title="My Landscape Report"));
append(rpt,TableOfContents);
append(rpt,Chapter(Title="Tests"));
append(rpt,Chapter(Title="Unit Tests"));
close(rpt);
rptview(rpt);

章タイトルの接頭辞のロケールの指定

Locale プロパティを設定して、レポートの章タイトルの接頭辞を日本語に設定します。

import mlreportgen.report.*
rpt = Report("Japanese Report");
rpt.Locale = "ja";
house = char(23478); % Kanji character for house
append(rpt, Chapter(house));
close(rpt);
rptview(rpt);

バージョン履歴

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 メソッドを使用してください。レポート API オブジェクトへのコンテンツの追加に append を使用することの利点は、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);

参考

mlreportgen.report.Reporter

mlreportgen.report.Report クラス

説明

クラス属性

作成

説明

プロパティ

OutputPath — 生成されたレポート ファイルのパス 文字ベクトル | string スカラー

属性:

Type — 出力タイプ "pdf" (既定値) | "docx" | "html" | "html-file" | "pdfa"

属性:

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

属性:

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

属性:

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

属性:

Debug — デバッグ モード false または 0 (既定値) | true または 1

属性:

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

属性:

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

属性:

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

属性:

メソッド

パブリック メソッド

例

レポートの作成

横向きのレポートの作成

章タイトルの接頭辞のロケールの指定

バージョン履歴

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

R2020b: add メソッドは非推奨

参考

トピック

`OutputPath` — 生成されたレポートファイルのパス
文字ベクトル | string スカラー

`Type` — 出力タイプ
`"pdf"` (既定値) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

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

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

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

`Debug` — デバッグモード
`false` または `0` (既定値) | `true` または `1`

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

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

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

パブリックメソッド

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