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

Frame

概要​

<Frame> は、<Grid> <Table> 要素に対して、改ページに対応したヘッダーやフッターを付加する要素です。

XMLの記述例​

レイアウトXML​

<Table> 要素に対して、カスタムのヘッダー・フッターを付加する例を示します。

<Frame>
  <FramePageHeader>
    <!-- Tableの列幅に合わせてGridの列を設定 -->
    <Grid cols="20 20 20" rows="auto" borderThickness="regular">
      <GridCell colspan="3"><Text align="center">カスタムヘッダー</Text></GridCell>
    </Grid>
  </FramePageHeader>

  <Table items="${items}" rowHeight="5" minRows="5" borderThickness="regular">
    <TableColumn width="20">
      <TableColumnTemplate>
        <Text>${column0}</Text>
      </TableColumnTemplate>
    </TableColumn>
    <TableColumn width="20">
      <TableColumnTemplate>
        <Text>${column1}</Text>
      </TableColumnTemplate>
    </TableColumn>
    <TableColumn width="20">
      <TableColumnTemplate>
        <Text>${column2}</Text>
      </TableColumnTemplate>
    </TableColumn>
  </Table>

  <FrameFooter>
    <!-- Tableの列幅に合わせてGridの列を設定 -->
    <Grid cols="20 20 20" rows="auto" borderThickness="regular">
      <GridCell colspan="3"><Text align="center">カスタムフッター</Text></GridCell>
    </Grid>
  </FrameFooter>
</Frame>

<Table> には以下のようなデータを入力します。

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

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

描画結果

スタイルXML​

<Frame key="style1" />
注記

スタイル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での記述
記述できません。

key​

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

注記

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

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

関連情報​