Main Content

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

mlreportgen.report.Report クラス

パッケージ: mlreportgen.report

レポート コンテナー

説明

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

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

プロパティ

すべて展開する

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

メモ

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

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

サポートされているレポート タイプ説明

'zipped'

'docx' または 'html'

OutputPath プロパティで指定された場所に zip ファイルとしてレポートを生成します。この zip ファイルは、ドキュメント タイプと一致する拡張子をもちます (Word 出力であれば docx、HTML 出力であれば htmtx)。たとえば、ドキュメント タイプが docx であり、OutputPaths:\docs\MyDoc であれば、その出力は s:\docs\MyDoc.docx という名前の zip ファイルにパッケージ化されます。

'unzipped'

'docx' または 'html'

OutputPath プロパティのファイル名をもつフォルダー内に、個別のファイルとしてレポートを生成します。たとえば、OutputPaths:\docs\MyDoc であれば、出力フォルダーは s:\docs\MyDoc となります。

'both'

'docx' または 'html'

圧縮した出力と未圧縮の出力を生成します。

'single-file'

'pdf' または 'html-file'

レポートを単一のファイルとして生成します。

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

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

  • 'pdf' – PDF ファイル

  • 'html' – レポートの HTML ファイル、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮したファイルとしてパッケージ化した HTML レポート。未圧縮のファイルを含むフォルダーとして HTML レポートを生成するには、PackageType プロパティを 'unzipped' または 'both' に設定します。

  • 'html-file' – レポートのテキスト、スタイル シート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルで構成される HTML レポート。

  • 'docx'Microsoft® Word ドキュメント。

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

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

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

メモ

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

ロケールまたは言語。このレポートが生成されるロケールの 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'。サポートされていないロケールを指定すると、英語バージョンが使用されます。https://en.wikipedia.org/wiki/List_of_ISO_639-1_codesを参照してください。

例については、章タイトルの接頭辞の変換を参照してください。

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

レポートのコンテンツを生成するのに使用する、基となる DOM ドキュメント オブジェクト。mlreportgen.dom.Document オブジェクトとして指定します。このプロパティは読み取り専用です。

レポート コンテキスト。現在のレポート セクションの階層レベルなど、レポート生成のための情報を含む、containers.Map オブジェクトとして指定します。このプロパティは読み取り専用です。

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

メソッド

すべて展開する

すべて折りたたむ

レポート 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); 

互換性の考慮事項

すべて展開する

R2020b 以降は非推奨

R2017b で導入