API Docs

Get Record List Style

Get Record List Style - kintone.app.getRecordListStyle()

Retrieves the style of the record list view (table view) for the current App.
Set the style using the following API
Set Record List Style

Function

Desktop

kintone.app.getRecordListStyle()

Mobile

kintone.mobile.app.getRecordListStyle()

Returns

A Promise object.
The following values can be retrieved when the Promise object is fulfilled:

Property Type Description
header Array The header style settings.
The elements of each column are returned from left to right.
header[].columnType String The type of the column that is styled.
  • FIELD: Field column
  • ACTION: Action UI column
header[].column String The column that is styled.
  • When columnType is FIELD, the field code is returned.
  • When columnType is ACTION, one of the following values is returned:
    • OPEN_DETAIL: The column for the show record details button
    • RECORD_ACTIONS: The column for the record edit button / delete button
header[].content Object The header column style settings
header[].content.color String The text color of the header.
Returns DEFAULT if no style is set.
header[].content.fontWeight String The font weight of the text in the header.
Returns DEFAULT if no style is set.
header[].content.textDecoration String The text decoration of the header, such as underline or strikethrough.
Returns DEFAULT if no style is set.
header[].background Object The background style settings of the header.
header[].background.backgroundColor String The background color of the header.
Returns DEFAULT if no style is set.
body Array The list body style settings.
The elements of each column are returned from top to bottom.
body[].recordId String The Record ID of the record being styled
body[].style Array The record style settings.
The elements of each column are returned from left to right.
body[].style[].columnType String The type of the column that is styled.
  • FIELD: Field column
  • ACTION: Action UI column
body[].style[].column String The column that is styled.
  • When columnType is FIELD, the field code is returned.
  • When columnType is ACTION, one of the following values is returned:
    • OPEN_DETAIL: The column for the show record details button
    • RECORD_ACTIONS: The column for the record edit button / delete button
body[].style[].content Object The field content style settings
body[].style[].content.backgroundColor String The background color of the field.
Returns DEFAULT if no style is set.
body[].style[].content.color String The text color of the field content.
Returns DEFAULT if no style is set.
body[].style[].content.fontWeight String The font weight of the text in the field content.
Returns DEFAULT if no style is set.
body[].style[].content.textDecoration String The text decoration of the field content, such as underline or strikethrough.
Returns DEFAULT if no style is set.
body[].style[].content.borderColor String The border color of the field content.
Returns DEFAULT if no style is set.
body[].style[].background Object The field background style settings
body[].style[].background.backgroundColor String The background color of the field.
Returns DEFAULT if no style is set.

Available Pages

Desktop

  • Record List page

Mobile

  • Record List page

Notes

Mobile

  • Retrieving the style of the column for the record edit button / delete button is not supported.
  • Retrieving content.borderColor and content.backgroundColor is not supported.