最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

mlreportgen.dom.MATLABTable クラス

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

説明

MATLAB® table を DOM table に変換します。

構築

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

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

入力引数

すべて展開する

MATLAB table。

データ型: double

table に適用するスタイル。文字ベクトルとして指定します。

プロパティ

すべて展開する

背景色。次のいずれかとして指定します。

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.crockford.com/wrrrld/color.html を参照してください。

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

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

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

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

'dashed'

破線

すべての出力タイプ

'dashdotstroked'

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

Word

'dashsmallgap'

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

Word

'dotted'

点線

すべての出力タイプ

'dotdash'

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

Word

'dotdotdash'

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

Word

'double'

二重線

すべての出力タイプ

'doublewave'

二重波線

Word

'groove'

3D 効果溝付き線

HTML および PDF

'hidden'

線なし

この表の下にある詳細を参照してください。

HTML および PDF

'inset'

3D 効果線

すべての出力タイプ

'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.crockford.com/wrrrld/color.html を参照してください。

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

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

この読み取り専用プロパティには、このオブジェクトの子要素がリストされます。

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

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

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

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.crockford.com/wrrrld/color.html を参照してください。

  • #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 プロパティを設定します。

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

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

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

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

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

この読み取り専用プロパティには、このドキュメント要素の親がリストされます。

行の名前を含む最初の列でルールをオンにするプロパティ。logical として指定します。MATLAB table オブジェクトは行の名前を定義しなければなりません。

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

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

次を指定できます。

  • 色の名前。名前は CSS の色の名前にしなければなりません。https://www.crockford.com/wrrrld/color.html を参照してください。

  • #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 — ポイント

ドキュメント要素のタグ。文字ベクトルとして指定します。

セッション固有 ID は、ドキュメント要素作成の一環として生成されます。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS は要素のクラスです。ID はオブジェクトの Id プロパティの値です。タグを指定して、生成されたタグを置き換えることができます。

たとえば、ドキュメントの生成中に問題が発生した箇所の特定を容易にするために、独自のタグ値を指定できます。

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

メソッド

メソッド

目的

append

TableRow.append を使用する方法と同様に FormalTable.append を使用します。

テーブルにテーブル エントリの行を追加します。

clone

Paragraph.clone を使用する方法と同様に FormalTable.clone を使用します。

テーブルをコピーします。

MATLABTable オブジェクトを使用したテーブルの作成

この例では、テーブルをレポートに追加する MATLABTable オブジェクトを使用する方法を示します。この例では、行名の列のルールを追加します。

% Create a MATLAB table from workspace variables
load patients;
BloodPressure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPressure);
patients.Properties.RowNames = LastName;

% Create a report and create the MATLABTable object 
rpt = mlreportgen.dom.Document('MyFileName','pdf');
tbl = mlreportgen.dom.MATLABTable(patients);

% Add a header for the row name column and add a rule
tbl.Header.row(1).Children(1).append('Names');
tbl.RowNamesRule = true;

% Add the table to the report
append(rpt,tbl);
close(rpt);

% Display the report 
rptview(rpt.OutputPath);