テーブルフィールドに設定されているスタイルを取得する
警告
このページで説明しているAPIは、開発を検討中のAPIです。
アップデートオプション内の「検討中の新機能」から動作をお試しいただけます。
設定方法は、
新機能の有効/無効の切り替え手順
を参照してください。
APIに関するフィードバックを、ユースケースとともに、
kintoneの改善に協力する
フォームへぜひご登録ください。
フィードバックの例
- 「APIラボで提供されているAPIを早く本番環境で利用したい」
- 「こういう用途で使うために、このようなAPIを提供してほしい」
テーブルフィールドに設定されているスタイルを取得する
現在開いているレコードのテーブルフィールドのスタイルを取得します。
テーブルフィールドにスタイルを設定する
APIで設定したスタイルを取得できます。
利用するには、検討中の新機能の「JavaScript API:テーブルの行へのID付与、テーブル操作時のイベント発生、およびテーブル操作用APIを追加する機能」を有効にしてください。
このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。
関数
PC
kintone.app.record.getTableFieldStyle(fieldCode)モバイル
kintone.mobile.app.record.getTableFieldStyle(fieldCode)引数
| 引数名 | 型 | 必須 | 説明 |
|---|---|---|---|
| fieldCode | 文字列 | 必須 | スタイルを取得するテーブルのフィールドコード |
戻り値
戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の要素をもつオブジェクトが取得できます。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| header | 配列 | ヘッダーのスタイルの設定 PC版ではテーブルの左から順に、各列の要素が返ります。 モバイル版では、各行に表示される項目の上から順に返ります。 |
| header[].columnType | 文字列 | スタイリング対象の列のタイプ
|
| header[].column | 文字列 | スタイリング対象の列の指定
|
| header[].content | オブジェクト | ヘッダーのコンテンツのスタイルの設定 |
| header[].content.color | 文字列 | ヘッダーのコンテンツの文字色 スタイルが設定されていない場合は DEFAULTが返ります。 |
| header[].content.fontWeight | 文字列 | ヘッダーのコンテンツのフォントの太さ スタイルが設定されていない場合は DEFAULTが返ります。 |
| header[].content.textDecoration | 文字列 | ヘッダーのコンテンツの下線や取り消し線などの装飾 スタイルが設定されていない場合は DEFAULTが返ります。 |
| header[].background | オブジェクト | ヘッダーの背景のスタイルの設定 |
| header[].background.backgroundColor | 文字列 | ヘッダーの背景の背景色 スタイルが設定されていない場合は DEFAULTが返ります。 |
| body | 配列 | 各行のセルのスタイルの設定 テーブルの上から順に、各行の要素が返ります。 |
| body[].rowId | 文字列 | スタイリング対象の行のid |
| body[].style | 配列 | 行のスタイルの設定 PC版ではテーブルの左から順に、各列の要素が返ります。 モバイル版では、各行に表示される項目の上から順に返ります。 |
| body[].style[].columnType | 文字列 | スタイリング対象の列のタイプ
|
| body[].style[].column | 文字列 | スタイリング対象の列の指定
|
| body[].style[].content | オブジェクト | セルのコンテンツのスタイルの設定 |
| body[].style[].content.backgroundColor | 文字列 | セルのコンテンツの背景色 スタイルが設定されていない場合は DEFAULTが返ります。 |
| body[].style[].content.color | 文字列 | セルのコンテンツの文字色 スタイルが設定されていない場合は DEFAULTが返ります。 |
| body[].style[].content.fontWeight | 文字列 | セルのコンテンツのフォントの太さ スタイルが設定されていない場合は DEFAULTが返ります。 |
| body[].style[].content.textDecoration | 文字列 | セルのコンテンツの下線や取り消し線などの装飾 スタイルが設定されていない場合は DEFAULTが返ります。 |
| body[].style[].content.borderColor | 文字列 | セルのコンテンツの境界線の色 スタイルが設定されていない場合は DEFAULTが返ります。 |
| body[].style[].background | オブジェクト | セルの背景のスタイルの設定 |
| body[].style[].background.backgroundColor | 文字列 | セルの背景の背景色 スタイルが設定されていない場合は DEFAULTが返ります。 |
利用できる画面
PC
- レコード追加画面
- レコード編集画面
- レコード詳細画面
- レコード印刷画面
モバイル
- レコード追加画面
- レコード編集画面
- レコード詳細画面
注意事項
-
テーブルフィールドにスタイルを設定する
APIがスタイルの設定に対応していないプロパティは、
DEFAULTが返ります。 - 操作UI列の要素は、レコード追加画面とレコード編集画面でだけ返ります。
