append

クラス: mlreportgen.dom.Document
名前空間: mlreportgen.dom

ドキュメントへの DOM オブジェクトまたは MATLAB オブジェクトの追加

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

構文

domObjOut = append(docObj,textContent)
domObjOut = append(docObj,listContent)
domObjOut = append(docObj,tableContent)
domObjOut = append(docObj,paraObj,pageLayoutObj)
domObjOut = append(___,styleName)
domObjOut = append(docObj,domObj)

説明

domObjOut = append(docObj,textContent) は、テキストまたは数値をドキュメントに追加し、テキスト オブジェクトを返します。Microsoft® Word 出力と PDF 出力では、テキストが段落内で折り返されます。これは、折り返されていないテキストをドキュメント本文に追加することが Word と PDF で許可されていないためです。HTML 出力の場合、テキストは段落内で折り返されません。

domObjOut = append(docObj,listContent) は、順序なしリストを追加し、順序なしリスト オブジェクトを返します。

例

domObjOut = append(docObj,tableContent) はテーブルを追加し、テーブル オブジェクトを返します。

例

domObjOut = append(docObj,paraObj,pageLayoutObj) は、段落を追加し、pageLayoutObject によってプロパティが指定される新しいページ レイアウト セクションを開始し、段落オブジェクトを返します。

domObjOut = append(___,styleName) は、指定されたスタイルを使用して、指定されたコンテンツを追加します。

例

domObjOut = append(docObj,domObj) は、DOM オブジェクトをドキュメントに追加し、そのオブジェクトを返します。

例

入力引数

すべて展開する

コンテンツを追加するドキュメント。mlreportgen.dom.Document オブジェクトとして指定します。

ドキュメントに追加するテキスト。文字ベクトルまたは string スカラーとして指定します。text オブジェクトは段落オブジェクト内で折り返され、その段落がドキュメントに追加されます。テキストは、ドキュメント本文へのテキスト追加が許可されていない Microsoft Word との整合性を保つために、段落内で折り返されます。HTML の場合、テキストの折り返しによって予期しない動作が発生する可能性があります。

ドキュメントに追加するリスト オブジェクト。順序付きリスト、順序なしリスト、または配列として指定します。入力が double 値または文字列から成る水平方向の 1 次元配列または 1 次元の categorical 配列である場合、順序なしリスト オブジェクトが作成され、そのリスト オブジェクトがドキュメントに追加されます。

ドキュメントに追加するテーブル オブジェクト。次のいずれかとして指定します。

  • double 値の 2 次元配列 — Table オブジェクトを追加して返す

  • 文字列の 2 次元配列 — Table オブジェクトを追加して返す

  • 2 次元の categorical 配列 — Table オブジェクトを追加して返す

  • テーブル ヘッダーの文字列から成る cell 配列と、テーブル本体の数値、cell 配列、または categorical 配列 — FormalTable オブジェクトを追加して返す

  • MATLAB table — MATLABTable オブジェクトを追加して返す

ドキュメントに追加する段落。段落オブジェクトとして指定します。また、pageLayoutObj 入力で指定されたプロパティを使用して、新しいページ レイアウト セクションを開始します。

追加されたページ レイアウト セクションに適用するページ レイアウト。PageLayout オブジェクトとして指定します。

テキスト、テーブル、またはリストの入力に適用するスタイル。

出力引数

すべて展開する

追加されたオブジェクトが返されます。オブジェクトのタイプは、2 番目の入力タイプによって異なります。

例

すべて展開する

ライブ スクリプトを開く

OrderedList オブジェクトを作成し、レポートに追加します。 

import mlreportgen.dom.*;
d = Document('mydoc','html');

ol = OrderedList({'first step' 'second step' 'last step'});
append(d,ol);

close(d);
rptview('mydoc','html');

テキストには Word Title スタイルを使用します。

import mlreportgen.dom.*;
d = Document("mydoc","docx");
append(d,"This Is a Title","Title");
close(d);
rptview("mydoc","docx");

ワークスペース変数から patients という名前の MATLAB® table を作成します。

load patients;
BloodPreasure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPreasure);
patients.Properties.RowNames = LastName;

Age 変数に基づいてテーブルを並べ替えます。

load patients;
BloodPreasure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPreasure);
patients.Properties.RowNames = LastName;

Age 変数に基づいてテーブルを並べ替えます。

sorted = sortrows(patients,"Age");

並べ替えられた patients table を含む PDF レポートを作成します。

rpt = mlreportgen.dom.Document("MyFileName","pdf");
append(rpt,sorted);
close(rpt);

PDF レポートをビューアーで表示します。

rptview(rpt.OutputPath)
ライブ スクリプトを開く
import mlreportgen.dom.*;
d = Document('mydoc');
table = append(d,{'row 1 - col 1' 'row 1 - col 2';...
    'row 2 - col 1' 'row 2 - col 2'});
table.Style = {Border('double'),ColSep('solid'),RowSep('solid')};
close(d);
rptview('mydoc','html');

ヒント

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

バージョン履歴

R2014b で導入

参考

クラス

トピック