メインコンテンツまでスキップ
version: v2.1

Table

概要​

<Table> は、入力データを表形式で動的に描画する要素です。

XMLの記述例​

レイアウトXML​

<Table items="${items}" rowHeight="5" minRows="5" borderThickness="regular">
  <TableColumn width="auto">
    <TableColumnHeader>
      <Text>column0 header</Text>
    </TableColumnHeader>
    <TableColumnTemplate>
      <Text>${column0}</Text>
    </TableColumnTemplate>
    <TableColumnFooter>
      <Text>column0 footer</Text>
    </TableColumnFooter>
  </TableColumn>
  <TableColumn width="auto">
    <TableColumnHeader>
      <Text>column1 header</Text>
    </TableColumnHeader>
    <TableColumnTemplate>
      <Text>${column1}</Text>
    </TableColumnTemplate>
    <TableColumnFooter>
      <Text>column1 footer</Text>
    </TableColumnFooter>
  </TableColumn>
</Table>

この <Table> の例では、テンプレート変数に items が指定されています。 これに対して、以下のようなデータを入力します。

{
  "items":[
    {
      "column0":"col0 row0",
      "column1":"col1 row0"
    },
    {
      "column0":"col0 row1",
      "column1":"col1 row1"
    }
  ]
}

このXMLと入力データでは、以下のように描画されます。

描画例

スタイルXML​

<Table key="style1" outerBorderThickness="thick" />

属性​

items​

<Table> に入力するデータを設定します。

注記

この属性の値は、テンプレート変数のみ指定可能です。

データ型
Array
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

rowHeight​

行の高さを設定します。

データ型
FlexHeight （単位 : mm）
必須
省略可能です。既定値は auto です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

minRows​

最小行数を設定します。 items で入力したデータの件数が minRows に満たない場合、不足分の空行を挿入します。

データ型
UnsignedInteger
必須
省略可能です。既定値は 0 です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

breakCondition​

行ごとの改ページ条件を設定します。

注記

この属性の値は、テンプレート変数のみ指定可能です。

指定したテンプレート変数が true と評価される場合、その行の直前に改ページを行います。

この属性の指定は <LayoutBody> の直下の <Table> でのみ使用可能です（間に <Frame> が入っているケースも含む）。 それ以外の場所では、この属性の指定は無視されます。

データ型
Boolean
必須
省略可能です。既定値は false です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

borderThickness​

罫線の太さを設定します。

データ型
StrokeThickness （単位 : mm）
必須
省略可能です。既定値は 0 です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

borderColor​

罫線の色を設定します。

データ型
Color
必須
省略可能です。既定値は black です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

borderStyle​

罫線の描画パターンを設定します。

データ型
StrokeStyle
必須
省略可能です。既定値は solid です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

outerBorderThickness​

外枠の罫線の太さを設定します。 borderThickness と同時に指定した場合、外側の罫線には outerBorderThickness が適用され、内側の罫線には borderThickness が適用されます。

データ型
EdgeBorderThickness （単位 : mm）
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

outerBorderColor​

外枠の罫線の色を設定します。 borderColor と同時に指定した場合、外側の罫線には outerBorderColor が適用され、内側の罫線には borderColor が適用されます。

データ型
EdgeBorderColor
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

outerBorderStyle​

外枠の罫線の描画パターンを設定します。 borderStyle と同時に指定した場合、外側の罫線には outerBorderStyle が適用され、内側の罫線には borderStyle が適用されます。

データ型
EdgeBorderStyle
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

headerBackgroundColor​

ヘッダー行の背景色を設定します。

データ型
Color
必須
省略可能です。既定値は transparent です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

footerBackgroundColor​

フッター行の背景色を設定します。

データ型
Color
必須
省略可能です。既定値は transparent です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

width​

描画領域の幅を設定します。

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
UnsignedFloat （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

x​

この要素を配置するX座標（水平方向の位置）を指定します。 座標の基準点は origin プロパティで指定します。

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Float （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

y​

この要素を配置するY座標（垂直方向の位置）を指定します。 座標の基準点は origin プロパティで指定します。

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Float （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

origin​

X/Y座標の基準点を設定します。

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Origin
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

breakInside​

この要素の改ページ制御ルールを設定します。

データ型
BreakInside
必須
省略可能です。既定値は auto です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

logic​

この要素に適用する制御構造を設定します。

データ型
Logic
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

style​

この要素に適用するスタイルの識別名を設定します。

データ型
StyleName
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

rangeStyle​

この要素にセル範囲指定で適用するスタイルの識別名を設定します。

データ型
StyleName
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

key​

この要素のスタイル名を設定します。

注記

この属性はスタイルXMLでのみ使用できます。

データ型
StyleName
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

関連情報​