Main Content

mlreportgen.dom.MATLABTable クラス

パッケージ: mlreportgen.dom
スーパークラス: mlreportgen.dom.FormalTable

説明

mlreportgen.dom.MATLABTable クラスのオブジェクトを使用して MATLAB® table を DOM table に変換します。

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

クラス属性

HandleCompatible
true
ConstructOnLoad
true

作成

説明

MLTableObj = mlreportgen.dom.MATLABTable(table) は、指定した MATLAB table に基づいたテーブル オブジェクトを作成します。

MLTableObj = mlreportgen.dom.MATLABTable(table,stylename) はテーブル オブジェクトを作成し、StyleName プロパティを stylename に設定します。この table を含むレポートを生成するために使用するテンプレートにスタイルを定義します。

入力引数

すべて展開する

DOM table の生成に使用される MATLAB table。MATLAB table として指定します。

プロパティ

すべて展開する

テーブルの背景色。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

テーブル本体。mlreportgen.dom.TableBody オブジェクトとして指定します。テーブル コンストラクターは、テーブル本体オブジェクトを作成して、形式的テーブルを構築するときにこのプロパティに割り当てます。このプロパティを後で設定することはできません。ただし、テーブル本体にコンテンツを追加し、このプロパティを使用してそのプロパティを設定できます。

属性:

GetAccess
public
SetAccess
private
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" として指定します。"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

このテーブルのフッター。mlreportgen.dom.TableFooter オブジェクトとして指定します。テーブル コンストラクターは、テーブル フッター オブジェクトを作成して、形式的テーブルを構築するときにこのプロパティに割り当てます。このプロパティを後で設定することはできません。ただし、テーブル本体にコンテンツを追加し、このプロパティを使用してそのプロパティを設定できます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

  • "center"

  • "left"

  • "right"

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テーブル ヘッダー。mlreportgen.dom.TableHeader オブジェクトとして指定します。テーブル コンストラクターは、テーブル ヘッダー オブジェクトを作成して、形式的テーブルを構築するときにこのプロパティに割り当てます。このプロパティを後で設定することはできません。ただし、テーブル本体にコンテンツを追加し、このプロパティを使用してそのプロパティを設定できます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

見出しの水平方向のルール。mlreportgen.dom.HorizontalRule オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

列数。整数として指定します。

属性:

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

行の名前を含む最初の列を有効にするかどうか。logical として指定します。MATLAB table オブジェクトは行の名前を定義しなければなりません。

属性:

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

形式的テーブル セクションの StyleName プロパティを設定できます。StyleName の設定は、形式的テーブルによって指定したスタイルをオーバーライドします。ただし、Word ドキュメントにこれを行う場合は、セクションで各列の幅を明示的に指定して確実にすべてのセクションを同じ幅にしなければなりません。HTML および PDF とは異なり、Word には形式的テーブルの組み込みサポートはありません。これを処理するために、DOM インターフェイスでは、形式的テーブルをセクションごとに 3 行 1 列のテーブルに組み込んだ 3 つのテーブルとして表します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

属性:

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

メソッド

すべて展開する

すべて折りたたむ

この例では、行名をもつ MATLAB table から DOM table を作成します。この例では、DOM table を含む 2 つのレポートを生成します。最初のレポートでは、テーブルの行名の列にラベルがありません。2 番目のレポートでは、行名の列にラベルがあります。

患者の年齢、体重、身長を表示する MATLAB table を作成します。RowNames オプションを使用して、患者の姓で各行を識別します。

LastName = {'Sanchez';'Johnson';'Lee';'Diaz';'Brown'};
Age = [38;43;38;40;49];
Weight = [176;163;131;133;119];
Height = [71;69;64;67;64];
mltable = table(Age,Weight,Height,'RowNames',LastName)
mltable=5×3 table
               Age    Weight    Height
               ___    ______    ______

    Sanchez    38      176        71  
    Johnson    43      163        69  
    Lee        38      131        64  
    Diaz       40      133        67  
    Brown      49      119        64  

この MATLAB table には 5 つの行と 3 つの列があります。行名は table の一部ではありません。それらは table のプロパティに格納されます。

MATLAB table から mlreportgen.dom.MATLABTable オブジェクトを作成します。

import mlreportgen.dom.*
mltableObj = MATLABTable(mltable);

ドキュメントを作成し、MATLABTable オブジェクトをドキュメントに追加します。ドキュメントを閉じて表示します。

d = Document('MyMATLABTable1','docx');
append(d,mltableObj);
close(d);
rptview(d);

生成されたレポートのテーブルは次のようになります。

DOM table は、ヘッダーと本体をもつ正式なテーブルです。このテーブルには 5 つの行と 4 つの列があります。最初の列は、MATLAB table の行名で構成されています。

レポートを再度生成します。今回は行名の列にラベルを使用します。ラベルを指定するには、テーブル ヘッダー行の最初のエントリ内の空のテキストをラベル テキストに置き換えます。ラベルの下に線を引くには、MATLABTable オブジェクトの RowNamesRule プロパティを true に設定します。

LastName = {'Sanchez';'Johnson';'Lee';'Diaz';'Brown'};
Age = [38;43;38;40;49];
Weight = [176;163;131;133;119];
Height = [71;69;64;67;64];
mltable = table(Age,Weight,Height,'RowNames',LastName);
import mlreportgen.dom.*
mltableObj = MATLABTable(mltable);
th = mltableObj.Header;
thentry11 = entry(th,1,1);
thentry11.Children(1).Children(1).Content = 'Names';
mltableObj.RowNamesRule = true;
d = Document('MyMATLABTable2','docx');
append(d,mltableObj);
close(d);
rptview(d);

生成されたレポートのテーブルは次のようになります。

バージョン履歴

R2016b で導入