mlreportgen.report.BaseTable クラス

名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter

テーブルレポーターの作成

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

説明

mlreportgen.report.BaseTable クラスのオブジェクトを使用して、タイトルをもつテーブルのレポーターを作成します。

mlreportgen.report.BaseTable クラスは handle クラスです。

クラス属性

HandleCompatible true

作成

説明

table = mlreportgen.report.BaseTable は、空のテーブルレポーターを作成します。レポータープロパティを使用して、テーブルのコンテンツ、タイトル、スタイル、および幅を指定します。

table = mlreportgen.report.BaseTable(content) はテーブルレポーターを作成し、Content プロパティを content に設定します。

例

table = mlreportgen.report.BaseTable(Name=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順番で指定できます。

プロパティ

すべて展開する

`Title` — テーブルのタイトル
文字ベクトル | string スカラー | ...

テーブルのタイトル。次の値のいずれかとして指定します。

文字ベクトルまたは string スカラー
DOM 要素オブジェクト
string または DOM 要素オブジェクトから成る 1 行 N 列または N 行 1 列の配列
string、文字ベクトル、または DOM 要素オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列
getTitleReporter メソッドによって返されるホールレポーター

文字ベクトルまたは string スカラー
インライン DOM オブジェクト (mlreportgen.dom.Text オブジェクトなど)
string スカラーまたはインライン DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列
string、文字ベクトル、またはインライン DOM オブジェクトの任意の組み合わせを含む 1 行 N 列または N 行 1 列の cell 配列
getTitleReporter メソッドによって返される mlreportgen.report.Title オブジェクト

タイトルの値がインラインコンテンツ (段落に含まれるコンテンツ) の場合、テーブルレポーターはテンプレートライブラリに格納されているテンプレートを使用してタイトルを書式設定します。テンプレートは、テーブルが番号付きの章にあるか番号なしの章にあるかによって異なる書式を使用して、テーブルのタイトルに自動的に番号を付けます。

番号が付けられた章のテーブルは、"表 N.M" という形式のタイトルテキストの接頭辞をもちます。ここで、N は章番号、M は章内のテーブル番号です。たとえば、レポートの 2 番目の章にある 3 番目のテーブルの接頭辞は Table 2.3 になります。
番号なしの章のテーブルには、"Table N" という形式のタイトルテキストの接頭辞があります。ここで、N は、レポートの最初のテーブルでは 1、2 番目のテーブルでは 2 のようになります。

英語以外の多くのロケールでは、タイトルの接頭辞がロケールの言語と形式に変換されます。変換済みロケールのリストについては、mlreportgen.report.Report の Locale プロパティを参照してください。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Content` — テーブルのコンテンツ
`mlreportgen.dom.Table` オブジェクト | `mlreportgen.dom.FormalTable` オブジェクト | `mlreportgen.dom.MATLABTable` オブジェクト | ...

テーブルのコンテンツ。次の値のいずれかとして指定します。

mlreportgen.dom.Table オブジェクト
mlreportgen.dom.FormalTable オブジェクト
mlreportgen.dom.MATLABTable オブジェクト
DOM オブジェクトまたは組み込み MATLAB^® オブジェクトの 2 次元配列または cell 配列
getContentReporter メソッドによって返されるホールレポーター

BaseTable コンストラクターまたは add メソッドを使用して、このプロパティを設定します。直接設定することはできません。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`TableStyleName` — テーブルに適用するスタイル
文字ベクトル | string スカラー

テーブルに適用するスタイルの名前。文字ベクトルまたは string スカラーとして指定します。指定するスタイルは、このテーブルを追加するレポートで使用されるテンプレートまたはレポートに追加されるレポーターのテンプレートで定義されているテーブルスタイルでなければなりません。

TableStyleName が空の場合、テーブルスタイルはレポーターのテンプレートによって定義された既定のテーブルスタイル (グリッド) になります。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`TableWidth` — テーブルの幅
`[]` | 文字ベクトル | string スカラー

このテーブルの幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。有効な略語を以下に示します。

"px" — ピクセル
"cm" — センチメートル
"in" — インチ
"mm" — ミリメートル
"pc" — パイカ
"pt" — ポイント

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`MaxCols` — テーブルスライスごとに表示する列の最大数
`Inf` (既定値) | 正の整数

テーブルスライスごとに表示する列の最大数。Inf または正の整数として指定します。このプロパティの値が Inf の場合、元のテーブルのすべての列が 1 つのテーブルに含められます。MaxCols 値がテーブル列の数以上であっても、すべての列を含む 1 つのテーブルが生成されます。大きなテーブルデータセットは判読できない場合があります。このプロパティを、ページに正しく収まる元のテーブルの列数に設定します。最適な値を決定するには、MaxCols 値の設定とレポートの表示を繰り返します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: int32

`RepeatCols` — スライスごとに繰り返す初期列の数
0 (既定値) | 正の整数

スライスごとに繰り返す初期列の数。0 または正の整数として指定します。非ゼロの数値 n は、各スライスで元のテーブルの最初の n 列を繰り返します。MaxCols プロパティ値は RepeatCols プロパティ値を含みます。たとえば、MaxCols が 6 で RepeatCols が 2 の場合、各テーブルスライスには合計 6 つの列があり、最初の 2 つの列が元のテーブルから繰り返されます。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: int32

`TableSliceTitleStyleName` — テーブルスライスのタイトルに適用するスタイルの名前
`[]` (既定値) | 文字ベクトル | string スカラー

テーブルスライスのタイトルに適用するカスタムスタイルの名前。string または文字ベクトルとして指定します。指定するスタイルは、このレポーターが追加されるレポートで定義されていなければなりません。このプロパティが空 (""、""、または []) の場合、スライスタイトルはレポーターテンプレートで定義されている既定のスタイルを使用します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`TableEntryUpdateFcn` — テーブルエントリ更新のコールバック
`[]` (既定値) | 関数ハンドル

テーブルエントリ更新のコールバック。関数ハンドルとして指定します。コールバック関数は、入力引数として mlreportgen.dom.TableEntry オブジェクトを受け入れます。BaseTable オブジェクトをレポートに追加すると、テーブルがレポートに追加される前に、テーブルエントリごとにコールバック関数が 1 回トリガーされます。この関数を使用し、エントリのコンテンツに基づいてテーブルエントリの外観をカスタマイズします。例については、PDF レポートのコンテンツでのテーブルエントリのカスタマイズを参照してください。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: function_handle

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

このレポーターのテンプレートのソース。次のいずれかの方法で指定します。

このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、レポーターまたはレポート
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、ドキュメントオブジェクトモデル (DOM) ドキュメントまたはドキュメントパーツ

指定するテンプレートは、このレポーターを追加するレポートと同じタイプでなければなりません。たとえば、Microsoft^® Word レポートでは、TemplateSrc は Word レポーターテンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーターテンプレートを使用します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレートライブラリになければなりません。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

このレポーターのハイパーリンクターゲット。リンクターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンクターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

メソッド

すべて展開する

パブリックメソッド

メソッド	目的
`getContentReporter`	ベーステーブルのコンテンツホールレポーターの取得
`getTitleReporter`	ベーステーブルのタイトルレポーターの取得
`mlreportgen.report.BaseTable.createTemplate`	`template = mlreportgen.report.BaseTable.createTemplate(path,type)` レポーターテンプレートの作成入力引数 `path`。テンプレートファイルのターゲットパスとファイル名 `type`。テンプレートタイプ (`"html"`、`"docx"`、または `"pdf"` として指定) 戻り値 `template` — テンプレートのコピーのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.createTemplate` を参照してください。
`mlreportgen.report.BaseTable.customizeReporter`	`reporter` `= mlreportgen.report.BaseTable.customizeReporter(classpath)` `mlreportgen.report.BaseTable` クラスから派生させたレポーターの作成戻り値 `reporter` — 新しいレポータークラスのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.customizeReporter` を参照してください。
`mlreportgen.report.BaseTable.getClassFolder`	`path = mlreportgen.report.BaseTable.getClassFolder` `mlreportgen.report.BaseTable` クラス定義ファイルが含まれるフォルダーの場所の取得戻り値 `path` — クラス定義ファイルの場所。文字ベクトルとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.getClassFolder` を参照してください。
`copy`	レポーターオブジェクトのコピーの作成および特定のプロパティ値のディープコピーの作成
`getImpl`	レポーターの実装の取得

例

すべて折りたたむ

レポートへのタイトル付きテーブルの追加

ライブスクリプトを開く

この例では、タイトル付きの 2 つのテーブルをレポートに追加する方法を示します。最初のテーブルはランク 5 の魔方陣です。2 番目のテーブルには 2 つのイメージが含まれています。

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

rpt = Report("tables");
chapter = Chapter();
chapter.Title = "Table example";
add(rpt,chapter);

table = BaseTable(magic(5));
table.Title = "Rank 5 Magic Square";
add(rpt,table);

add(rpt,Paragraph());
imgSize = {Height("2in"),Width("2in")};
img1 = Image("b747.jpg");
img1.Style = imgSize;
img2 = Image("peppers.png");
img2.Style = imgSize;
table = BaseTable({"Boeing 747" "Peppers"; img1, img2});
table.Title = "Picture Gallery";
add(rpt,table);

delete(gcf);
rptview(rpt);

PDF レポートのコンテンツでのテーブルエントリのカスタマイズ

ライブスクリプトを開く

この例では、mlreportgen.report.BaseTable レポーターを使用するときに、エントリのコンテンツに基づいてテーブルエントリをカスタマイズする方法を示します。この例は、MATLAB $^{®}$ version R2022a 以降でのみ実行できます。

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

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

学生の名前と成績を含むテーブルを作成します。

Student_names = ["Charlie","Sarah","John","Teena","Alfred","Emma","Bill","Tyler"]';
Student_grades = [83,42,75,98,78,49,91,88]';
studentsTable = FormalTable(["Student Name","Student Grade"],[Student_names,Student_grades]);
studentsTable.Header.Style{end+1} = BackgroundColor("silver");
studentsTable.Width = "250pt";

学生テーブルを使用して mlreportgen.dom.BaseTable レポーターを作成します。

baseTabReporter = BaseTable(studentsTable);

ファイル tabEntryUpdateCB.mlx で定義されているコールバック関数 tabEntryUpdateCB のハンドルをレポーターの TableEntryUpdateFcn プロパティに割り当てます。

コマンドラインでコマンド edit tabEntryUpdateCB を使用して、コールバック関数のコードを表示します。

baseTabReporter.TableEntryUpdateFcn = @tabEntryUpdateCB;

PDF タイプの mlreportgen.dom.Report を作成し、ベーステーブルレポーターをレポートに追加します。

document = Report("Update_table_entries_example_report","pdf");
append(document,baseTabReporter);

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

close(document);
rptview(document);

バージョン履歴

R2017b で導入

参考

トピック

レポーターとは

mlreportgen.report.BaseTable クラス

説明

クラス属性

作成

説明

プロパティ

Title — テーブルのタイトル 文字ベクトル | string スカラー | ...

属性:

Content — テーブルのコンテンツ mlreportgen.dom.Table オブジェクト | mlreportgen.dom.FormalTable オブジェクト | mlreportgen.dom.MATLABTable オブジェクト | ...

属性:

TableStyleName — テーブルに適用するスタイル 文字ベクトル | string スカラー

属性:

TableWidth — テーブルの幅 [] | 文字ベクトル | string スカラー

属性:

MaxCols — テーブル スライスごとに表示する列の最大数 Inf (既定値) | 正の整数

属性:

RepeatCols — スライスごとに繰り返す初期列の数 0 (既定値) | 正の整数

属性:

TableSliceTitleStyleName — テーブル スライスのタイトルに適用するスタイルの名前 [] (既定値) | 文字ベクトル | string スカラー

属性:

TableEntryUpdateFcn — テーブル エントリ更新のコールバック [] (既定値) | 関数ハンドル

属性:

TemplateSrc — このレポーターのテンプレートのソース 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ

属性:

TemplateName — このレポーターのテンプレートの名前 文字ベクトル | string スカラー

属性:

LinkTarget — このレポーターのハイパーリンク ターゲット [] (既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget オブジェクト

属性:

メソッド

パブリック メソッド

例

レポートへのタイトル付きテーブルの追加

PDF レポートのコンテンツでのテーブル エントリのカスタマイズ

バージョン履歴

参考

トピック

`Title` — テーブルのタイトル
文字ベクトル | string スカラー | ...

`Content` — テーブルのコンテンツ
`mlreportgen.dom.Table` オブジェクト | `mlreportgen.dom.FormalTable` オブジェクト | `mlreportgen.dom.MATLABTable` オブジェクト | ...

`TableStyleName` — テーブルに適用するスタイル
文字ベクトル | string スカラー

`TableWidth` — テーブルの幅
`[]` | 文字ベクトル | string スカラー

`MaxCols` — テーブルスライスごとに表示する列の最大数
`Inf` (既定値) | 正の整数

`RepeatCols` — スライスごとに繰り返す初期列の数
0 (既定値) | 正の整数

`TableSliceTitleStyleName` — テーブルスライスのタイトルに適用するスタイルの名前
`[]` (既定値) | 文字ベクトル | string スカラー

`TableEntryUpdateFcn` — テーブルエントリ更新のコールバック
`[]` (既定値) | 関数ハンドル

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

パブリックメソッド

PDF レポートのコンテンツでのテーブルエントリのカスタマイズ