Main Content

mlreportgen.dom.Table クラス

パッケージ: mlreportgen.dom

説明

mlreportgen.dom.Table クラスのオブジェクトを使用して、略式テーブルを定義します。これは、本体のみをもつテーブルです。個別のヘッダー セクションやフッター セクションをもちません。

mlreportgen.dom.Table クラスは handle クラスです。

クラス属性

HandleCompatible
true
ConstructOnLoad
true

作成

説明

tableObj = mlreportgen.dom.Table(nCols) は、空のテーブルを作成し、NCol プロパティを nCols に設定します。テーブルを作成する場合、この構文を開始点として使用します。

tableObj = mlreportgen.dom.Table(array) は、array で指定されたコンテンツをもつテーブルを作成します。コンストラクターによって、基本の MATLAB® 型が、対応する DOM 型に変換されます。たとえば、文字ベクトルは mlreportgen.dom.Text オブジェクトに変換されます。

tableObj = mlreportgen.dom.Table(array,style) は、テーブルを作成し、Style プロパティを style に設定します。style で指定するスタイルは、このテーブルを追加するドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

入力引数

すべて展開する

テーブル本体のコンテンツ。以下として指定します。

  • 2 次元数値配列

  • 2 次元 categorical 配列

  • 2 次元 string 配列

  • 以下のタイプの配列、データ型、またはオブジェクトを含む 2 次元 cell 配列:

    • 文字ベクトル

    • string スカラー

    • 1 次元または 2 次元の cell 配列

    • データ型 double の項目

    • mlreportgen.dom.Text オブジェクト

    • mlreportgen.dom.Paragraph オブジェクト

    • mlreportgen.dom.Image オブジェクト

    • mlreportgen.dom.Table オブジェクト

    • mlreportgen.dom.FormalTable オブジェクト

    • mlreportgen.dom.OrderedList オブジェクト

    • mlreportgen.dom.UnorderedList オブジェクト

    • mlreportgen.dom.ExternalLink オブジェクト

    • mlreportgen.dom.InternalLink オブジェクト

    • mlreportgen.dom.CharEntity オブジェクト

    • mlreportgen.dom.LineBreak オブジェクト

プロパティ

すべて展開する

テーブルの背景色。CSS の色名または 16 進数の RGB 値で構成される文字ベクトルまたは string スカラーとして指定します。

  • CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

  • 16 進数の RGB 書式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

BackgroundColor プロパティを設定すると、mlreportgen.dom.BackgroundColor 書式オブジェクトが Style プロパティに追加されます。BackgroundColor プロパティを空の値に設定すると、そのオブジェクトは削除されます。

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

描画する境界線のタイプ。次の表のいずれかの値として指定します。

境界線の値説明サポートされる出力タイプ

"dashed"

破線

すべての出力タイプ

"dashdotstroked"

斜めの破線と点が交互に入った線

Word

"dashsmallgap"

破線間に小さい隙間がある破線

Word

"dotted"

点線

すべての出力タイプ

"dotdash"

点と破線が交互に入った線

Word

"dotdotdash"

2 つの点と 1 本の破線が交互に入った線

Word

"double"

二重線

すべての出力タイプ

"doublewave"

二重波線

Word

"groove"

3D 効果溝付き線

HTML および PDF

"hidden"

線なし

境界線タイプ "none" も線を生成しません。ただし、競合する境界線の処理が、"hidden" タイプと "none" タイプで異なります。境界線タイプ "hidden" は、競合する境界線タイプよりも優先されます。競合する境界線タイプは、"none" タイプよりも優先されます。

HTML および PDF

"inset"

3D 効果線

すべての出力タイプ

"none"

線なし

境界線タイプ "hidden" も線を生成しません。ただし、競合する境界線の処理が、"hidden" タイプと "none" タイプで異なります。境界線タイプ "hidden" は、競合する境界線タイプよりも優先されます。競合する境界線タイプは、"none" タイプよりも優先されます。

すべての出力タイプ

"outset"

3D 効果線

すべての出力タイプ

"ridge"

3D 効果突起付き線

HTML および PDF

"single"

一重線

Word

"solid"

一重線

HTML および PDF

"thick"

太い線

Word

"thickthinlargegap"

太い破線と細い破線が交互に入った隙間の大きい破線

Word

"thickthinmediumgap"

太い破線と細い破線が交互に入った隙間が中程度の破線

Word

"thickthinsmallgap"

太い破線と細い破線が交互に入った隙間の小さい破線

Word

"thinthicklargegap"

細い破線と太い破線が交互に入った隙間の大きい破線

Word

"thinthickmediumgap"

細い破線と太い破線が交互に入った隙間が中程度の破線

Word

"thinthicksmallgap"

細い破線と太い破線が交互に入った隙間の小さい破線

Word

"thinthickthinlargegap"

細い破線と太い破線が交互に入った隙間の大きい破線

Word

"thinthickthinmediumgap"

細い破線と太い破線が交互に入った隙間が中程度の破線

Word

"thinthickthinsmallgap"

細い破線と太い破線が交互に入った隙間の小さい破線

Word

"threedemboss"

エンボス加工した効果線

Word

"threedengrave"

彫り込み効果線

Word

"triple"

三重線

Word

"wave"

波線

Word

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

"on" の値は、単一境界線に隣接したセルの境界線を折りたたみます。"off" の値は隣接したセルの境界線を保持します。このプロパティは、HTML ドキュメントにのみ適用されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブルの境界線の色。CSS の色名または 16 進数の RGB 値で構成される文字ベクトルまたは string スカラーとして指定します。

  • CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

  • 16 進数の RGB 書式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

テーブルの列を分ける線のスタイル。文字ベクトルまたは string スカラーとして指定します。

使用可能な値の説明については、属性 Border の説明を参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

列を分ける線の色。CSS の色名または 16 進数の RGB 値で構成される文字ベクトルまたは string スカラーとして指定します。

  • CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

  • 16 進数の RGB 書式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル列を分ける線の幅。数値とそれに続く測定単位の略語で構成される string スカラーまたは文字ベクトルとして指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

列のグループの幅、配置、およびその他のプロパティ。mlreportgen.dom.TableColSpecGroup オブジェクトの配列として指定します。最初のオブジェクトが列の最初のグループに、2 番目のオブジェクトが 2 番目のグループに適用されます。以下同様に続きます。TableColSpecGroup オブジェクトの Span プロパティを使用して、各グループに属する列数を指定します。たとえば、最初のオブジェクトは、範囲が 2 の場合、最初の 2 つの列に適用されます。2 番目のグループは、範囲が 3 の場合、次の 3 つの列に適用されます。以下同様に続きます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブルのカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このドキュメント要素を追加するドキュメントの出力タイプによってサポートされなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストが記述される方向。以下のいずれか 1 つを値として指定します。

  • "ltr" — テキストが左から右へ記述される

  • "rtl" — テキストが右から左へ記述される

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このテーブルの水平方向の配置。以下のいずれかの値として指定します。

  • "center"

  • "left"

  • "right"

メモ

PDF 出力でテーブルが大きい場合にオーバーフローしないようにするには、Width プロパティを設定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このテーブルの列数。整数として指定します。列数を指定するには、構文 mlreportgen.dom.Table(nCols) を使用してテーブルを作成します。そうでない場合、列数は、テーブルのコンテンツに基づきコンストラクター Table によって決定されます。テーブルへの行の追加または行へのエントリの追加によって列数が変化すると、NCols プロパティの値が更新されます。行によってエントリの数が異なる場合、テーブル エントリの数が最も多い行によってテーブルの列数が決まります。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このテーブルの行数。整数として指定します。行数は、テーブルのコンテンツに基づき Table コンストラクターによって決定されます。テーブルに行を追加すると、NRows プロパティの値が更新されます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

テーブルの左余白。数値とそれに続く測定単位の略語で構成される string スカラーまたは文字ベクトルとして指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

テーブルの行を分ける線のスタイル。文字ベクトルまたは string スカラーとして指定します。

使用可能な値の説明については、Border プロパティの説明を参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル行を分ける線の色。CSS の色名または 16 進数の RGB 値で構成される文字ベクトルまたは string スカラーとして指定します。

  • CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

  • 16 進数の RGB 書式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル行を分ける線の幅。数値とそれに続く測定単位の略語で構成される string スカラーまたは文字ベクトルとして指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このテーブルのスタイルを定義する書式設定。DOM 書式設定オブジェクトの cell 配列として指定します。この書式設定は、StyleName プロパティで指定したスタイルシートのスタイルで定義した対応する書式をオーバーライドします。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このテーブルを追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前。文字ベクトルまたは string スカラーとして指定します。

StyleName プロパティで指定されたスタイルは、このテーブルを追加するドキュメントまたはドキュメント パーツのスタイルシートで定義されていなければなりません。指定されたスタイルは、この Table オブジェクトの Style プロパティで指定された書式を除いて、出力ドキュメントでのテーブルの外観を定義します。Style プロパティで指定された書式設定オブジェクトは、スタイルシートで定義された書式をオーバーライドします。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル エントリの水平方向の配置。以下のいずれかの値として指定します。

  • "center"

  • "left"

  • "right"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル セルのコンテンツの垂直方向の配置。以下のいずれかの値として指定します。

  • "top"

  • "middle"

  • "bottom"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル エントリの内側の余白。数値とそれに続く測定単位の略語で構成される string スカラーまたは文字ベクトルとして指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル エントリに使用するスタイル。書式設定オブジェクトの cell 配列として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

ページ幅に対する割合 ("100%" など) または測定単位の数値。数値とそれに続く測定単位の略語で構成される string スカラーまたは文字ベクトルとして指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

Word レポートの場合、幅は余白を差し引いたページ幅の割合として計算されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

メソッド

すべて展開する

すべて折りたたむ

この例では、Table オブジェクトを使用してテーブルを作成し、そのプロパティを指定します。

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

import mlreportgen.dom.*;

Document オブジェクトを作成し、それを開きます。

d = Document("myreport","html");
open(d); 

5 行 5 列の MATLAB 配列を使用して、テーブル オブジェクトを作成し、コンテンツを指定します。この数値配列は、同じ次元の DOM オブジェクト テーブルに変換されます。

t = Table(magic(5));

行の高さを指定します。

t.Style = {RowHeight("1in")};

行の幅とスタイル、および列の区切りを指定します。

t.Border = "solid";
t.BorderWidth = "1px";
t.ColSep = "solid";
t.ColSepWidth = "1";
t.RowSep = "solid";
t.RowSepWidth = "1";

テーブル エントリのスタイルを設定します。

t.TableEntriesStyle = [t.TableEntriesStyle {FontFamily("Arial"),Width("1in"),Color("red"),Bold}];

テーブル内におけるテキストの水平方向と垂直方向の配置を設定します。

t.TableEntriesHAlign = "center";
t.TableEntriesVAlign = "middle";

テーブルをドキュメントに追加します。

append(d,t);

ドキュメントを閉じてレポートを表示します。

close(d);
rptview(d);

バージョン履歴

R2015b で導入