警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「検討中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効／無効の切り替え手順 を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintoneの改善に協力する フォームへぜひご登録ください。

フィードバックの例

• 「APIラボで提供されているAPIを早く本番環境で利用したい」
• 「こういう用途で使うために、このようなAPIを提供してほしい」

指定したテーブルフィールドに、カスタマイズ列を作成します。
カスタマイズ列は、テーブルのヘッダーおよび各行のセルに、APIから指定した内容を表示できる機能です。
作成したカスタマイズ列は、戻り値のオブジェクトを使って更新、または削除できます。

利用するには、検討中の新機能の「JavaScript API：テーブルの行へのID付与、テーブル操作時のイベント発生、およびテーブル操作用APIを追加する機能」を有効にしてください。

このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。

• はじめようJavaScript：Promiseとasync/await
• はじめようkintone API：kintoneカスタマイズで非同期処理をする

PC

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の要素をもつオブジェクトが取得できます。

kintone.app.record.createCustomTableColumn()が返したPromiseオブジェクトの解決時に得られるupdate()関数により、作成したカスタマイズ列の設定を更新できます。

関数

引数

引数のconfigは、カスタマイズ列を作成するときのconfigと同じ形式です。
指定したプロパティだけが更新され、省略したプロパティは変わりません。

• config.header.labelを指定すると、ヘッダーのラベルが置き換わります。
• config.body[]に指定した行は、セルの内容がcontentsの内容に置き換わります。指定しなかった行のセルは変わりません。
• 画面に存在しない行のidを指定した場合、その行の指定は無視されます。

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に値は返りません。
削除済みのカスタマイズ列に対して実行した場合は、何もせずに解決します。

kintone.app.record.createCustomTableColumn()が返したPromiseオブジェクトの解決時に得られるremove()関数により、作成したカスタマイズ列を削除できます。

関数

引数

なし

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に値は返りません。
削除済みのカスタマイズ列に対して実行した場合は、何もせずに解決します。

PC

• レコード追加画面
• レコード編集画面
• レコード詳細画面
• レコード印刷画面

カスタマイズ列を作成する

次のコードは、レコード詳細画面を表示したときに、テーブル（フィールドコード：テーブル）の末尾に「操作」列を作成する例です。
各行に「コピー」ボタンを表示し、クリックするとその行の文字列1行（フィールドコード：文字列__1行）の値をクリップボードにコピーします。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

kintone.events.on('app.record.detail.show', (event) => {
  const rows = event.record['テーブル'].value;
  kintone.app.record.createCustomTableColumn('テーブル', {
    header: {label: '操作'},
    body: rows.map((row) => ({
      rowId: row.id,
      contents: [
        {
          type: 'BUTTON',
          text: 'コピー',
          description: '文字列1行の値をクリップボードにコピーします',
          onClick: async ({rowId}) => {
            const target = rows.find((r) => r.id === rowId);
            await navigator.clipboard.writeText(target.value['文字列__1行'].value);
          },
        },
      ],
    })),
  });
  return event;
});

カスタマイズ列を更新、削除する

次のコードは、作成したカスタマイズ列のヘッダーのラベルをupdate()で更新してから、remove()でカスタマイズ列を削除する例です。

1
2
3
4
5

const column = await kintone.app.record.createCustomTableColumn('テーブル', {
  header: {label: '更新前'},
});
await column.update({header: {label: '更新後'}});
await column.remove();

• カスタマイズ列は、画面の表示だけを変更します。レコードのデータには保存されません。
• 行を追加、削除、または並べ替えると、カスタマイズ列のセルも行に追従します。
  追加した行のセルは空です。内容を表示するには、update()で追加した行のidを指定してください。
• 画面を再描画する操作（レコード詳細画面と編集画面の切り替え、前後のレコードへの移動、再読み込みなど）を行うと、カスタマイズ列は削除されます。