append

クラス: mlreportgen.report.Report
名前空間: mlreportgen.report

レポートへのコンテンツの追加

このページをすべて展開する

構文

append(report,content)

説明

append(report,content) は指定されたコンテンツをレポートに追加します。レポートのステータスが "unopened" の場合、append メソッドはステータスを "open" に設定し、コンテンツを追加します。レポートのステータスが "closed" に設定されている場合、append メソッドはエラー メッセージを返します。

メモ

レポーターをレポートに複数回追加できますが、そのレポーターを別のレポートに追加することはできません。たとえば、あるレポートに mlreportgen.report.TitlePage レポーターを追加する場合、そのレポーターを他のレポートに追加することはできません。

入力引数

すべて展開する

レポート。mlreportgen.report.Report オブジェクトとして指定します。

レポートに追加するコンテンツ。レポート API レポーター、DOM オブジェクト、または組み込み MATLAB® オブジェクトとして指定します。コンテンツは、レポート API レポーター、または DOM ドキュメントに追加できる任意のオブジェクトです。DOM ドキュメントに追加できるコンテンツには、DOM オブジェクトと多くの組み込み MATLAB オブジェクト (string、文字ベクトル、cell 配列など) が含まれます。

例

すべて展開する

ライブ スクリプトを開く

この例では、mlreportgen.report.Report オブジェクトの append メソッドを使用して、レポートにタイトル ページ、目次、および章を追加します。章にコンテンツを追加するために、この例では、mlreportgen.report.Chapter オブジェクトの append メソッドを使用します。

長い完全修飾クラス名を使用せずに済むよう、DOM および API パッケージをインポートします。

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

レポートを作成し、レポートにタイトルと目次を追加します。

rpt = Report("Magic Square Magic");
append(rpt, TitlePage("Title","Magic Square Magic","Subtitle", ...
    "Inverting a Magic Square","Author","John Doe"));
append(rpt,TableOfContents);

章を作成し、章にコンテンツを追加します。 

ch = Chapter("Magic Moments");
m = magic(5);
append(ch,BaseTable("Title","m = magic(5)","Content", m));
mInverse = m^-1;
append(ch,BaseTable("Title","mInverse = magic(5)^-1","Content", ...
    cellfun(@(x) sprintf("%0.3f", x),num2cell(mInverse), ...
    "UniformOutput", false)));
append(ch,BaseTable("Title", "m*mInverse","Content", ...
    cellfun(@(x) sprintf("%0.3f", x),num2cell(m*mInverse), ...
    "UniformOutput", false)));
append(ch, Paragraph(sprintf("sum(m(1,:)) - sum(m(:,1)) = %d", ...
    sum(m(1,:)) - sum(m(:,1)))));
append(ch, Paragraph(sprintf("sum(mInverse(1,:)) - sum(mInverse(:,1)) = %0.3f", ...
    sum(mInverse(1,:)) - sum(mInverse(:,1)))));

レポートに章を追加します。

append(rpt,ch);

レポートを閉じて表示します。

close(rpt);
rptview(rpt);

制限

  • report に content を追加すると、content にさらにコンテンツを追加することはできません。

ヒント

  • mlreportgen.dom.Text オブジェクト、mlreportgen.dom.Number オブジェクト、mlreportgen.dom.InternalLink、または mlreportgen.dom.ExternalLink オブジェクトのインスタンスをレポートに追加する場合、追加されるオブジェクトのコンテンツはレポートの形式に応じて異なります。HTML レポートでは、コンテンツは同じ行に追加されます。PDF および DOCX のレポートでは、コンテンツは別々の行に追加されます。同じ行にコンテンツを追加するには、mlreportgen.dom.Paragraph オブジェクトを作成し、append メソッドを使用してコンテンツを段落オブジェクトに追加し、その段落オブジェクトをレポート オブジェクトに追加します。

  • imagePath として PDF を使用する mlreportgen.dom.Image オブジェクトを追加する場合、イメージの最初のページのみが表示されます。

  • imagePath として PDF を使用する mlreportgen.dom.Image オブジェクトを追加する場合、イメージとレポートは同じバージョンの PDF ファイル形式を使用しなければなりません。PDF ファイルのバージョンを確認する方法の詳細については、Adobe Web サイトの文書のプロパティとメタデータの概要を参照してください。

バージョン履歴

R2020b で導入

参考

クラス

関数

トピック