kintone API

フィールドのスタイルの設定

目次

フィールドのスタイルの設定

現在開いているレコードのフィールドにスタイルを設定します。

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

関数

PC

kintone.app.record.setFieldStyle(fieldCode, config)

引数

パラメーター名 必須 説明
fieldCode 文字列 必須 スタイルを設定するフィールドのフィールドコード
config オブジェクト/文字列 必須 スタイルの設定
  • オブジェクトを指定した場合は、その設定に沿ってフィールドにスタイルが適用されます。
  • DEFAULTを指定した場合は、すべてのスタイルの適用が解除されます。
config.content オブジェクト/文字列 省略可 フィールドのコンテンツに適用するスタイルの設定
  • オブジェクトを指定した場合は、その設定に沿ってスタイルが適用されます。
  • DEFAULTを指定した場合は、スタイルの適用が解除されます。
config.content.backgroundColor 文字列 省略可 フィールドのコンテンツの背景色
#ffffffのような16進数で6桁のカラーコードを指定します。
config.content.color 文字列 省略可 フィールドのコンテンツの文字色
#ffffffのような16進数で6桁のカラーコードを指定します。
config.content.fontWeight 文字列 省略可 フィールドのコンテンツのフォントの太さ
以下の値を指定できます。
  • normal
  • bold
config.content.textDecoration 文字列 省略可 フィールドのコンテンツの下線や取り消し線などの装飾
以下の値を指定できます。
  • none
  • underline
  • line-through
config.content.borderColor 文字列 省略可 フィールドのコンテンツの境界線の色
#ffffffのような16進数で6桁のカラーコードを指定します。
config.background オブジェクト/文字列 省略可 フィールドの背景に適用するスタイルの設定
  • オブジェクトを指定した場合は、その設定に沿ってスタイルが適用されます。
  • DEFAULTを指定した場合は、スタイルの適用が解除されます。
config.background.backgroundColor 文字列 省略可 フィールドの背景の背景色
#ffffffのような16進数で6桁のカラーコードを指定します。
config.label オブジェクト/文字列 省略可 フィールド名に適用するスタイルの設定
  • オブジェクトを指定した場合は、その設定に沿ってスタイルが適用されます。
  • DEFAULTを指定した場合は、スタイルの適用が解除されます。
config.label.color 文字列 省略可 フィールド名の文字色
#ffffffのような16進数で6桁のカラーコードを指定します。
config.label.fontWeight 文字列 省略可 フィールド名のフォントの太さ
以下の値を指定できます。
  • normal
  • bold
config.label.textDecoration 文字列 省略可 フィールド名の下線や取り消し線などの装飾
以下の値を指定できます。
  • none
  • underline
  • line-through

各プロパティにDEFAULTという文字列を設定することで個別にスタイルの適用を解除できます。

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に値は返りません。

サンプルコード

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// 設定
const config = {
  content: { // フィールドのコンテンツ(入力要素など)のスタイル
    backgroundColor: '#95d542',
    color: 'DEFAULT', // スタイルの解除
    fontWeight: 'bold',
    textDecoration: 'none',
    borderColor: '#ff8f00'
  },
  background: { // フィールドの背景のスタイル
    backgroundColor: '#ffbf00'
  },
  label: { // フィールド名のスタイル
    color: '#ff4949',
    fontWeight: 'bold',
    textDecoration: 'underline'
  }
};

// スタイル適用
await kintone.app.record.setFieldStyle('文字列__1行_', config);

// スタイル解除
await kintone.app.record.setFieldStyle('文字列__1行_', 'DEFAULT');

利用できる画面

PC
  • レコード追加画面
  • レコード編集画面

注意事項

装飾設定の組み合わせにより、軽微な表示崩れを起こす場合があります。
今後製品のアップデートにより、各プロパティに対応する細かな装飾範囲などは変更される場合があります。

制限事項

次のフィールドは非対応です。

  • ステータス
  • 作業者
  • テーブル
  • 関連レコード一覧
  • グループ
  • 罫線
  • ラベル
  • スペース

次のフィールドはcontentの設定が非対応です。

  • リッチエディター
  • 計算
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • 「自動計算する」を有効にした、文字列(1行)