Main Content

レポート プログラムの作成

MATLAB® Report Generator™ には、Report Generator プログラムを作成できるクラスが含まれています。これらのプログラムは、Word、HTML および PDF レポートを生成できます。プログラムには特定の項目が含まれていなければなりません。また、複数のオプション項目 (ここにリストされている項目および関連付けられた各リンクで説明されている項目の両方) を含めることができます。レポート API の詳細およびドキュメント オブジェクト モデル (DOM) との比較については、レポーターとはを参照してください。

必須のレポート プログラム タスクと要素

すべての Report Generator プログラムは次のことを実行できなければなりません。

オプションのレポート プログラム タスクと要素

Report Generator プログラムでは、必要に応じて次のことを実行します。

  • レポート API クラスをインポートする。これにより、完全修飾されていないレポート API クラス名を使用できます (たとえば、mlreportgen.report.TitlePage ではなく TitlePage)。API パッケージのインポートを参照してください。

  • プログラムによって DOM オブジェクトをレポートに追加する場合に、DOM API クラスをインポートする。これにより、完全修飾されていない DOM API クラス名を使用できます。

  • プロパティ値を設定することでレポーターを構成する。コンテンツの生成を参照してください。

  • add メソッドを使用して、コンテンツをレポーターに追加する。

    メモ

    構成とコンテンツ追加の両方を実行できるレポーターは Section レポーターと Chapter レポーターのみです。Chapter レポーターは Section レポーターのサブクラスです。

  • レポートを表示して、生成されたレポート出力を確認する。レポートの表示を参照してください。

  • レポートの進行状況メッセージを表示して、レポートの進行状況を監視する。進行状況とデバッガー メッセージの表示を参照してください。

Report Generator プログラムの例

たとえば、この MATLAB コードでは、PDF レポートを生成して表示します。これには必須項目とオプション項目の両方が含まれています。

次のコマンドを実行して、この例で使用されているサポート ファイルにアクセスします。

openExample('rptgen/MatlabReportGeneratorSupportFilesExample');
% Import report API classes (optional)
import mlreportgen.report.*

% Add report container (required)
rpt = Report('output','pdf');

% Add content to container (required)
% Types of content added here: title 
% page and table of contents reporters
titlepg = TitlePage;
titlepg.Title = 'My Airplane';
titlepg.Author = 'Pilot A';
add(rpt,titlepg);
add(rpt,TableOfContents);

% Add content to report sections (optional)
% Text and formal image added to chapter
chap = Chapter('Plane Image');
add(chap,'Here is the plane:');
add(chap,FormalImage('Image',...
    which('b747.jpg'),'Height','5in',...
    'Width','5in','Caption','Boeing 747'));
add(rpt,chap);

% Close the report (required)
close(rpt);
% Display the report (optional)
rptview(rpt);

Report title page with the title "My Airplane", the author "Pilot A", and the date

Table of contents listing one image

A Boeing 747

関連するトピック