メインコンテンツ

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mlreportgen.dom.FormalTable クラス

名前空間: mlreportgen.dom

説明

形式的テーブルを定義します。これは、本体に加えて、オプションでテーブル ヘッダーかテーブル フッター、またはその両方をもつテーブルです。テーブル ヘッダー、本体、およびフッターはそれぞれ、mlreportgen.dom.TableHeader オブジェクト、mlreportgen.dom.TableBody オブジェクト、および mlreportgen.dom.TableFooter オブジェクトです。

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

作成

説明

formalTableObj = FormalTable は、空の形式的テーブルを作成します。このコンストラクターを開始点として使用し、形式的テーブルをゼロから作成します。

formalTableObj = FormalTable(ncols) は、列数が指定された空の形式的テーブルを作成します。

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

formalTableObj = FormalTable(body,styleName) は、本体のコンテンツとスタイルが指定された形式的テーブルを作成します。

formalTableObj = FormalTable(header,body) は、指定されたコンテンツを使用してヘッダーと本体をもつ形式的テーブルを作成し、さらに空のフッターを作成します。

formalTableObj = FormalTable(header,body,styleName) は、指定されたコンテンツとスタイルを使用して、形式的テーブルを作成します。テーブルは空のフッターをもちます。

formalTableObj = FormalTable(header,body,footer) は、本体、ヘッダー、およびフッターのコンテンツが指定された形式的テーブルを作成します。

メモ

Microsoft® Word は、スタイル名が一致する連続したテーブルを 1 つのテーブルに自動的に結合します。連続した各テーブルを DOCX レポートで別個のテーブルとして表示するには、次のオプションのいずれかを行います。

  • 連続した各テーブルのスタイル名を異なる値に設定します。

  • テーブル間に何らかのコンテンツを挿入します。たとえば、テーブル間に空の mlreportgen.dom.Paragraph 要素を挿入します。

入力引数

すべて展開する

テーブル内の列数。数値として指定します。

データ型: double

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

  • 2 次元数値配列

  • 2 次元 categorical 配列

  • 以下を含むことができる 2 次元 cell 配列

    • 文字ベクトル

    • 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 オブジェクト

テーブルのスタイル。文字ベクトルまたは string スカラーとして指定します。このプロパティのスタイルは、このテーブルを含むドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

cell 配列には以下を含めることができます。

  • 文字ベクトル

  • 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 オブジェクト

プロパティ

すべて展開する

CSS の色名または 16 進数の RGB 値を含む背景色。文字ベクトルまたは string スカラーとして指定します。

  • 色の名前を使用するには、CSS の色名を指定します。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

データ型: char | string

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

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

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

境界線のスタイル説明Microsoft Word でサポートHTML と PDF でサポート
"dashed"破線はいはい
"dashdotstroked"斜めの破線と点が交互に入った線はいはい
"dashsmallgap"破線間に小さい隙間がある破線はいはい
"dotted"点線はいはい
"dotdash"点と破線が交互に入った線はいいいえ
"dotdotdash"2 つの点と 1 本の破線が交互に入った線はいいいえ
"double"二重線はいはい
"doublewave"二重波線はいいいえ
"groove"3D 効果溝付き線いいえはい
"hidden"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルよりも "hidden" の境界線スタイルが優先されるため、線は非表示になります。

いいえはい
"inset"3D 効果線いいえはい
"none"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルは "none" よりも優先されるため、競合する境界線スタイルが表示されます。

はいはい
"outset"3D 効果線はいはい
"ridge"3D 効果突起付き線いいえはい
"single"一重線はいはい
"solid"一重線いいえはい
"thick"太い線はいいいえ
"thickthinlargegap"太い破線と細い破線が交互に入った隙間の大きい破線はいいいえ
"thickthinmediumgap"太い破線と細い破線が交互に入った隙間が中程度の破線はいいいえ
"thickthinsmallgap"太い破線と細い破線が交互に入った隙間の小さい破線はいいいえ
"thinthicklargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthicksmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"thinthickthinlargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickthinmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthickthinsmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"threedemboss"エンボス加工した効果線はいいいえ
"threedengrave"彫り込み効果線はいいいえ
"triple"三重線はいいいえ
"wave"波線はいいいえ

メモ

Microsoft Word レポートでは、mlreportgen.dom.Border オブジェクトを mlreportgen.dom.TableHeaderEntrymlreportgen.dom.TableEntry、または mlreportgen.dom.HorizontalRule オブジェクトの Style プロパティに割り当てた場合、このプロパティの "inset" スタイルまたは "outset" スタイルは、レポーターによってサポートされません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

隣接するセルの境界線を単一境界線に折りたたむかどうか。次として指定します。

  • "on" — 隣接するセルの境界線を単一境界線に折りたたむ

  • "off" — 隣接するセルの境界線を維持する

メモ

このプロパティは、HTML ドキュメントにのみ適用されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

境界線の色。CSS の色名または 16 進数の RGB 値を含む文字ベクトルまたは string スカラーとして指定します。

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

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

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブルの境界線幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

例: "2pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブルまたはテーブル セクションの列を分ける線のスタイル。次の値のいずれかとして指定します。

境界線のスタイル説明Microsoft Word でサポートHTML と PDF でサポート
"dashed"破線はいはい
"dashdotstroked"斜めの破線と点が交互に入った線はいはい
"dashsmallgap"破線間に小さい隙間がある破線はいはい
"dotted"点線はいはい
"dotdash"点と破線が交互に入った線はいいいえ
"dotdotdash"2 つの点と 1 本の破線が交互に入った線はいいいえ
"double"二重線はいはい
"doublewave"二重波線はいいいえ
"groove"3D 効果溝付き線いいえはい
"hidden"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルよりも "hidden" の境界線スタイルが優先されるため、線は非表示になります。

いいえはい
"inset"3D 効果線いいえはい
"none"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルは "none" よりも優先されるため、競合する境界線スタイルが表示されます。

はいはい
"outset"3D 効果線はいはい
"ridge"3D 効果突起付き線いいえはい
"single"一重線はいはい
"solid"一重線いいえはい
"thick"太い線はいいいえ
"thickthinlargegap"太い破線と細い破線が交互に入った隙間の大きい破線はいいいえ
"thickthinmediumgap"太い破線と細い破線が交互に入った隙間が中程度の破線はいいいえ
"thickthinsmallgap"太い破線と細い破線が交互に入った隙間の小さい破線はいいいえ
"thinthicklargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthicksmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"thinthickthinlargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickthinmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthickthinsmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"threedemboss"エンボス加工した効果線はいいいえ
"threedengrave"彫り込み効果線はいいいえ
"triple"三重線はいいいえ
"wave"波線はいいいえ

メモ

Microsoft Word レポートでは、mlreportgen.dom.Border オブジェクトを mlreportgen.dom.TableHeaderEntrymlreportgen.dom.TableEntry、または mlreportgen.dom.HorizontalRule オブジェクトの Style プロパティに割り当てた場合、このプロパティの "inset" スタイルまたは "outset" スタイルは、レポーターによってサポートされません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

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

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

例: "10pt" は 10 ポイントを指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストの記述方向。次の値のいずれかとして指定します。

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

  • "center"

  • "left"

  • "right"

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

R2024a 以降

テーブル列を並べ替え可能にするオプション。数値または logical の 1 (true) または 0 (false) として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

テーブルのコンテンツを同一ページ内に保持するかどうか。数値または logical の 1 (true) または 0 (false) として指定します。既定値は空で、true と等価です。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

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

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

例: "10pt" は 10 ポイントを指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブルまたはテーブル セクションの行を分ける線のスタイル。次の値のいずれかとして指定します。

境界線のスタイル説明Microsoft Word でサポートHTML と PDF でサポート
"dashed"破線はいはい
"dashdotstroked"斜めの破線と点が交互に入った線はいはい
"dashsmallgap"破線間に小さい隙間がある破線はいはい
"dotted"点線はいはい
"dotdash"点と破線が交互に入った線はいいいえ
"dotdotdash"2 つの点と 1 本の破線が交互に入った線はいいいえ
"double"二重線はいはい
"doublewave"二重波線はいいいえ
"groove"3D 効果溝付き線いいえはい
"hidden"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルよりも "hidden" の境界線スタイルが優先されるため、線は非表示になります。

いいえはい
"inset"3D 効果線いいえはい
"none"

線なし

競合する境界線スタイルがある場合、競合する境界線スタイルは "none" よりも優先されるため、競合する境界線スタイルが表示されます。

はいはい
"outset"3D 効果線はいはい
"ridge"3D 効果突起付き線いいえはい
"single"一重線はいはい
"solid"一重線いいえはい
"thick"太い線はいいいえ
"thickthinlargegap"太い破線と細い破線が交互に入った隙間の大きい破線はいいいえ
"thickthinmediumgap"太い破線と細い破線が交互に入った隙間が中程度の破線はいいいえ
"thickthinsmallgap"太い破線と細い破線が交互に入った隙間の小さい破線はいいいえ
"thinthicklargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthicksmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"thinthickthinlargegap"細い破線と太い破線が交互に入った隙間の大きい破線はいいいえ
"thinthickthinmediumgap"細い破線と太い破線が交互に入った隙間が中程度の破線はいいいえ
"thinthickthinsmallgap"細い破線と太い破線が交互に入った隙間の小さい破線はいいいえ
"threedemboss"エンボス加工した効果線はいいいえ
"threedengrave"彫り込み効果線はいいいえ
"triple"三重線はいいいえ
"wave"波線はいいいえ

メモ

Microsoft Word レポートでは、mlreportgen.dom.Border オブジェクトを mlreportgen.dom.TableHeaderEntrymlreportgen.dom.TableEntry、または mlreportgen.dom.HorizontalRule オブジェクトの Style プロパティに割り当てた場合、このプロパティの "inset" スタイルまたは "outset" スタイルは、レポーターによってサポートされません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

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

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

行の区切りの幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

例: "5pt"

属性:

NonCopyable
true

データ型: char | string

テーブル エントリに使用するスタイル。書式オブジェクトの cell 配列として指定します。このプロパティで指定されたスタイルは、テーブル エントリのコンテンツに適用され、エントリ自体には適用されません。たとえば、このプロパティを使用してテーブル エントリのフォント サイズを定義できますが、エントリの境界線のタイプや色を定義することはできません。境界線を指定するには、各エントリの Style プロパティを設定します。

メモ

このプロパティの以前の設定を誤って上書きしないように注意してください。たとえば、テーブルの TableEntriesHAlign プロパティを設定すると、HAlign 書式オブジェクトがこのプロパティに追加されます。このプロパティが上書きされないようにするには、このプロパティに書式を追加する他のテーブル プロパティを設定する前に、このプロパティを設定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

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

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

例: "10px" は 10 ピクセルを指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テーブルの幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"100%" は、PDF レポートではページ幅の 100% を指定し、Word レポートではページ幅の 100% から余白を差し引いた幅を指定します。有効な略語を以下に示します。

  • px — ピクセル

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • % — 割合

例: "5pt" は 5 ポイントを指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

ドキュメントまたはドキュメント パーツのスタイル シートのスタイル名。文字ベクトルまたは string スカラーとして指定します。このプロパティは、形式的テーブルの任意のセクションに対して設定できます。このプロパティを設定すると、ドキュメント内の形式的テーブルに指定されている既定のスタイルがオーバーライドされます。

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

このプロパティは、ハイフンを含む既定の Word ドキュメント スタイル名をサポートしていません。ハイフンを含む既定の Word ドキュメント スタイル名を使用するには、カスタム Word テンプレートでテーブルのスタイルを定義し、そのテンプレートを使用してドキュメントまたはドキュメント パーツを作成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素オブジェクトの書式指定。DOM 書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。このドキュメント要素オブジェクトに適用されない書式は無視されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このオブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このオブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

バージョン履歴

R2014b で導入

すべて展開する