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(outputPath) は、OutputPath プロパティを outputPath に設定します。

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

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

report = mlreportgen.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

プロパティ

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

メソッド

パブリック メソッド

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	レポート コンテキストの値の削除
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);

参考

mlreportgen.report.Reporter

トピック

• レポート プログラムの作成
• レポート コンテナーの作成
• 魔方陣についてのレポートの作成
• レポーターとは