レコードの一覧(表形式)のスタイルの取得
レコードの一覧(表形式)のスタイルの取得
現在開いているアプリのレコードの一覧(表形式)のスタイルを取得します。
レコードの一覧(表形式)のスタイルの設定
APIで設定したスタイルを取得できます。
このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。
関数
PC
kintone.app.getRecordListStyle()
モバイル
kintone.mobile.app.getRecordListStyle()
引数
なし
戻り値
戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の要素をもつオブジェクトが取得できます。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| header | 配列 | ヘッダー行のスタイルの設定 |
| 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[].recordId | 文字列 | スタイリング対象のレコードID |
| body[].style | 配列 | レコードのスタイルの設定 |
| 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
- レコード一覧画面(表形式)
モバイル
- レコード一覧画面(表形式)
注意事項
モバイルでは、レコードの編集/削除ボタンの列のスタイルの取得は非対応です。
モバイルでは、content.borderColorおよびcontent.backgroundColorの取得は非対応です。
