Main Content

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) は、本体、ヘッダー、およびフッターのコンテンツが指定された形式的テーブルを作成します。

入力引数

すべて展開する

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

データ型: 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 オブジェクト

styleName で指定するスタイルは、このテーブルを含むドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

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 の色名 (https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください) または #RRGGBB 形式の 16 進数の RGB (トゥルーカラー) 値で構成される文字ベクトルまたは string スカラーとして指定します。

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

例: 'blue'

例: '#0000ff'

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

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

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

'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

'on' の値は、隣接したセルの境界線を単一境界線に折りたたみます。'off' の値は、隣接したセルの境界線を保持します。

境界線の色。次のいずれかとして指定します。

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。

  • #RRGGBB としての 16 進数の RGB (トゥルーカラー) 値。たとえば、#0000ff は青色です。

テーブルの境界線幅。valueUnits の形式で指定します。ここで、Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

このドキュメント要素の子。DOM オブジェクトの配列として指定します。このプロパティは読み取り専用です。

テーブルまたはテーブル セクション (ヘッダー、本文、フッター) の列を分ける線のスタイル。mlreportgen.dom.ColSep オブジェクトで指定します。

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

列を分ける線の色。次のいずれかとして指定します。

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。

  • #RRGGBB としての 16 進数の RGB (トゥルーカラー) 値。たとえば、#0000ff は青色です。

valueUnits 形式でテーブル列を分ける線の幅。Units に対しては、次のいずれかの略語を使用します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

たとえば、3 ポイントの列の区切りでは、ColSepWidth プロパティを '3pt' に設定します。

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

カスタム属性は、このドキュメント要素を追加するドキュメントの出力タイプによってサポートされなければなりません。

列の配置方向。次のように指定します。

  • 'ltr' — 左から右への配置 (列 1 はテーブルの左側に配置されます)。

  • 'rtl' — 右から左への配置 (列 1 はテーブルの右側に配置されます)。

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

  • 'center'

  • 'left'

  • 'right'

メモ

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

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

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

valueUnits 形式の左インデント。Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

このドキュメント要素の親。DOM オブジェクトとして指定します。このプロパティは読み取り専用です。

テーブルまたはテーブル セクション (ヘッダー、本文、またはフッター) の行を分ける線のスタイル。

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

以下を指定できます。

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。

  • #RRGGBB としての 16 進数の RGB (トゥルーカラー) 値。たとえば、#0000ff は青色です。

行の区切りの幅。valueUnits の形式で指定します。ここで、Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

このテーブルに書式を指定する書式オブジェクト (Bold など) の配列。

このプロパティは、StyleName プロパティで指定したスタイル シートのスタイルで定義した対応する書式をオーバーライドします。

このテーブルを追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前

出力ドキュメントでこのテーブルの外観を指定するスタイル。Style プロパティによって指定されない書式用。

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

テーブル エントリの書式を指定する書式オブジェクトの cell 配列。

内側の余白はテーブル セルのコンテンツとセル境界線間の余白であり、形式は valueUnits です。ここで、Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

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

valueUnits 形式をもつ、ページ幅 (Word レポートの余白を引いたもの) に対する割合 (たとえば、'100%')、または測定単位の数値。Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

メソッド

すべて展開する

バージョン履歴

R2014b で導入