設定記錄清單(表格格式)的樣式

目錄

設定記錄清單(表格格式)的樣式

為目前開啟的應用程式記錄清單(表格格式)設定樣式。

此API為非同步API。
若需同步處理,請參閱以下頁面。

函式

PC

kintone.app.setRecordListStyle(config)

行動裝置

kintone.mobile.app.setRecordListStyle(config)

引數

參數名稱 類型 必填 說明
config 物件/字串 必填 樣式設定
  • 指定物件時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除所有樣式的套用。
config.header 陣列/字串 可省略 套用至標題列的樣式設定
  • 指定陣列時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 header 下方的樣式套用。
config.header[].columnType 字串 可省略 套用樣式的欄類型
可指定以下值。
  • FIELD:欄位欄
  • ACTION:操作 UI 欄
未指定時視為 FIELD
config.header[].column 字串 可省略 指定套用樣式的欄
  • columnTypeFIELD 時,指定欄位代碼。
  • columnTypeACTION 時,指定以下其中一個。
    • OPEN_DETAIL:顯示記錄詳情畫面的按鈕欄
    • RECORD_ACTIONS:記錄編輯/刪除按鈕欄
config.header[].content 物件/字串 可省略 套用至欄內容的樣式設定
  • 指定物件時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 content 下方的樣式套用。
config.header[].content.color 字串 可省略 欄內容的文字色
#ffffff 等 16 進制 6 位數的色碼指定。
config.header[].content.fontWeight 字串 可省略 欄內容的字體粗細
可指定以下值。
  • normal
  • bold
config.header[].content.textDecoration 字串 可省略 欄內容的底線或刪除線等裝飾
可指定以下值。
  • none
  • underline
  • line-through
config.header[].background 物件/字串 可省略 套用至欄背景的樣式設定
  • 指定物件時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 background 下方的樣式套用。
config.header[].background.backgroundColor 字串 可省略 欄背景的背景色
#ffffff 等 16 進制 6 位數的色碼指定。
config.body 陣列/字串 可省略 套用至清單本體的樣式設定
  • 指定陣列時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 body 下方的樣式套用。
config.body[].recordId 字串 可省略 套用樣式的記錄 ID
config.body[].style 陣列/字串 可省略 套用至記錄的樣式設定
  • 指定陣列時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 recordId 指定列的樣式套用。
config.body[].style[].columnType 字串 可省略 套用樣式的欄類型
可指定以下值。
  • FIELD:欄位欄
  • ACTION:操作 UI 欄
未指定時視為 FIELD
config.body[].style[].column 字串 可省略 套用樣式的欄指定
  • columnTypeFIELD 時,指定欄位代碼。
  • columnTypeACTION 時,指定以下其中一個。
    • OPEN_DETAIL:顯示記錄詳情畫面的按鈕欄
    • RECORD_ACTIONS:記錄編輯/刪除按鈕欄
config.body[].style[].content 物件/字串 可省略 套用至欄位內容的樣式設定
  • 指定物件時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 content 下方的樣式套用。
config.body[].style[].content.backgroundColor 字串 可省略 欄位內容的背景色
#ffffff 等 16 進制 6 位數的色碼指定。
僅在行內編輯期間套用。
config.body[].style[].content.color 字串 可省略 欄位內容的文字色
#ffffff 等 16 進制 6 位數的色碼指定。
config.body[].style[].content.fontWeight 字串 可省略 欄位內容的字體粗細
可指定以下值。
  • normal
  • bold
config.body[].style[].content.textDecoration 字串 可省略 欄位內容的底線或刪除線等裝飾
可指定以下值。
  • none
  • underline
  • line-through
config.body[].style[].content.borderColor 字串 可省略 欄位內容的框線顏色
#ffffff 等 16 進制 6 位數的色碼指定。
僅在行內編輯期間套用。
config.body[].style[].background 物件/字串 可省略 套用至欄位背景的樣式設定
  • 指定物件時,依該設定套用樣式。
  • 指定 DEFAULT 時,解除 background 下方的樣式套用。
config.body[].style[].background.backgroundColor 字串 可省略 欄位背景的背景色
#ffffff 等 16 進制 6 位數的色碼指定。

透過對各屬性設定 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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
const config = {
  header: [
    {
      column: '單行文字方塊_',
      content: {
        color: '#ffffff',
        fontWeight: 'bold',
        textDecoration: 'underline',
      },
      background: {
        backgroundColor: '#ff6f00',
      },
    },
    {
      columnType: 'ACTION',
      column: 'RECORD_ACTIONS',
      background: {
        backgroundColor: '#e65100',
      },
    },
    {
      columnType: 'ACTION',
      column: 'OPEN_DETAIL',
      background: {
        backgroundColor: '#ff6f00',
      },
    },
  ],
  body: [
    {
      recordId: '1',
      style: [
        {
          column: '單行文字方塊_',
          content: {
            backgroundColor: '#fff3e0',
            color: '#e65100',
            fontWeight: 'bold',
            borderColor: '#ff6f00',
            textDecoration: 'underline',
          },
          background: {
            backgroundColor: '#ffe0b2',
          },
        },
        {
          columnType: 'ACTION',
          column: 'OPEN_DETAIL',
          background: {
            backgroundColor: '#e65100',
          },
        },
        {
          columnType: 'ACTION',
          column: 'RECORD_ACTIONS',
          background: {
            backgroundColor: '#ff6f00',
          },
        },
      ],
    },
  ],
};

// 套用樣式
await kintone.app.setRecordListStyle(config);

// 解除所有樣式
await kintone.app.setRecordListStyle('DEFAULT');

可使用的畫面

PC
  • 記錄清單畫面(表格格式)
行動裝置
  • 記錄清單畫面(表格格式)

注意事項

裝飾設定的組合可能導致輕微的顯示異常。
今後產品更新後,各屬性對應的細部裝飾範圍等可能會有所變更。

限制事項

PC

以下欄位不支援。

  • 關聯記錄
  • 群組
  • 分隔線
  • 標籤
  • 空白
  • 表格內欄位

以下欄位不支援 content 的設定。

  • 文字編輯方塊
  • 表格

以下欄位不支援 content.borderColorcontent.backgroundColor 的設定。

  • 選項按鈕
  • 核取方塊
行動裝置

以下欄位不支援。

  • 關聯記錄
  • 群組
  • 分隔線
  • 標籤
  • 空白
  • 表格

以下欄位不支援 content 的設定。

  • 文字編輯方塊

不支援對記錄編輯/刪除按鈕欄設定樣式。

不支援 content.borderColorcontent.backgroundColor 的設定。