Table

Overview

Table は編集可能なテーブルを表示します。

---

Specification

Property

使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。

Name	Type	Default	Description	Remark
className	string	""	コンポーネントの class 名
id	string	""	コンポーネントの id 名
label	string	""	コンポーネントの説明ラベル	未指定、あるいは空文字の場合、label は表示されない
actionButton	boolean	true	行追加/削除ボタンの表示/非表示設定
visible	boolean	true	コンポーネントの表示/非表示設定
columns	Array<Column>	[]	コンポーネントの列データ	columns が配列以外の場合、エラーを出力する
data	Array<object>	[]	コンポーネントの行データ	data が配列以外の場合、エラーを出力する

Column

Name	Type	Default	Description	Remark
field	string	null	列のキー項目 ※必須かつ一意の値	data オブジェクトのキー項目になる そのキーに関連づけられた値が列に表示される field が columns 内で重複もしくは未指定の場合、エラーを出力する
title	string	""	列のヘッダー名
requiredIcon	boolean	false	コンポーネントの必須アイコン表示/非表示設定
visible	boolean	true	列の表示/非表示設定
render	function function(cellData, rowData, rowIndex) {}	null	セルの描画関数	DOM を戻り値にする 以下の3つのパラメーターを使って関数に情報を加えることができる cellData は現在表示されているセルの値 rowData は現在表示されている行の値 rowIndex は現在表示されている行番号 render 関数が未指定の場合、セルはデフォルトのテキストで表示される

Event

指定できるイベントの一覧です。

Name	Type	Description	Remark
change	function	テーブルの値が変更された時のイベントハンドラ	引数には Event の event オブジェクトをとる event.detail で以下の値を受け取ることができる change-cell（セルの値が変更された時にトリガーされる） event.detail.type: "change-cell" event.detail.rowIndex: 変更された行番号 event.detail.data: 変更後の data の値 event.detail.oldData: 変更前の data の値 event.detail.field: 変更された列の field の値 add-row（行追加ボタンがクリックされた時にトリガーされる） event.detail.type: "add-row" event.detail.rowIndex: 追加された行番号 event.detail.data: 変更後の data の値 event.detail.oldData: 変更前の data の値 remove-row（行削除ボタンがクリックされた時にトリガーされる） event.detail.type: "remove-row" event.detail.rowIndex: 削除された行番号 event.detail.data: 変更後の data の値 event.detail.oldData: 変更前の data の値

Constructor

Table(options)
使用できるコンストラクタの一覧です。

Parameter

Name	Type	Default	Description	Remark
options	object	{}	コンポーネントのプロパティを含むオブジェクト

---

Sample Code

ヒント

導入と実装方法 をご確認ください。

全てのパラメータを指定した場合のサンプルコードです。

const Kuc = Kucs['1.x.x'];

const space = kintone.app.record.getSpaceElement('space');

const renderAge = (dataCell) => {
  const spanElement = document.createElement("span");
  spanElement.innerText = `The age is ${dataCell}`;
  return spanElement;
};

const renderName = (cellData) => {
  const dropdown = new Dropdown({
    items: [
      { label: 'John Brown', value: 'john' },
      { label: 'Steven Gerrard', value: 'steven' },
    ],
    value: cellData,
  });
  return dropdown;
};

const table = new Kuc.Table({
  label: 'Table',
  columns: [
      {
        title: 'Name',
        field: 'name',
        render: renderName
      },
      {
        title: 'Address',
        field: 'address'
      },
      {
        title: 'Age',
        field: 'age',
        render: renderAge
      }
    ],
  data: [
    {
      name: 'john',
      age: 32,
      address: 'New York No. 1 Lake Park'
    },
    {
      name: 'steven',
      age: 22,
      address: 'New York No. 2 Lake Park'
    }
  ],
  className: 'options-class',
  id: 'options-id',
  actionButton: true,
  visible: true
});

space.appendChild(table);

table.addEventListener('change', event => {
  console.log(event);
});