列选项

Bootstrap Table 的列选项 API。

本页目录

列选项定义在 jQuery.fn.bootstrapTable.columnDefaults 中。

注意： 下面的选项名称（例如 align、checkbox、class）是在 columns 数组中定义列时使用的确切属性名。

例如：

$('#table').bootstrapTable({
  columns: [
    {
      field: 'id',
      title: 'ID',
      align: 'center'
    }
  ]
})

align

属性: data-align
类型: String
详情:

指定列数据的对齐方式。可以使用 'left'、'right'、'center'。
默认值: undefined
示例: Aligning Columns

cardVisible

属性: data-card-visible
类型: Boolean
详情:

设为 false 可在卡片视图模式下隐藏该列。
默认值: true
示例: Card Visible

cellStyle

属性: data-cell-style
类型: Function
详情:

单元格样式格式化函数，接收四个参数：
- value：字段值。
- row：行数据记录。
- index：行索引。
- field：行字段名。
支持返回 classes 或 css。
默认值: undefined
示例: Cell Style

checkbox

属性: data-checkbox
类型: Boolean
详情:

设为 true 时显示复选框。复选框列具有固定宽度。

如果提供了值，会自动勾选该复选框。也可通过 formatter 控制复选框状态（返回 true 勾选，返回 false 取消勾选）。
默认值: false
示例: Column Checkbox

checkboxEnabled

属性: data-checkbox-enabled
类型: Boolean
详情:

设为 false 可禁用复选框/单选框。
默认值: true
示例: Checkbox Enabled 与 Checkbox Disabled

class

属性: class | data-class
类型: String
详情:

列的类名。
默认值: undefined
示例: Column Class

clickToSelect

属性: data-click-to-select
类型: Boolean
详情:

设为 true 时，点击行会选中复选框或单选框。
默认值: true
示例: Click to Select

colspan

属性: colspan | data-colspan
类型: Number
详情:

指定单元格应跨越的列数。
默认值: undefined
示例: Rowspan Colspan

detailFormatter

属性: data-detail-formatter
类型: Function
详情:

当 detailView 和 detailViewByClick 均设为 true 时，此函数用于格式化详情视图。可返回字符串追加到详情视图单元格中，或直接使用第三个参数（目标单元格的 jQuery 对象）渲染元素。

未定义此函数时，将回退使用表格级别的 detail-formatter。
默认值: function(index, row, $element) { return '' }
示例: Detail Formatter

escape

属性: data-escape
类型: Boolean
详情:

对字符串进行 HTML 转义，替换其中的 &、<、>、"、` 和 ' 字符。
默认值: undefined
示例: Column Escape

events

属性: data-events
类型: Object
详情:

单元格事件监听器，在使用 formatter 函数时可接收四个参数：
- event：事件对象。
- value：字段值。
- row：行数据记录。
- index：行索引。
示例代码：
```
<th .. data-events="operateEvent">
var operateEvents = {
  'click .like': function (e, value, row, index) {}
}
```
默认值: undefined
示例: Column Events

falign

属性: data-falign
类型: String
详情:

指定如何对齐表格页脚。可以使用 'left'、'right'、'center'。
默认值: undefined
示例: Aligning Footer

field

属性: data-field
类型: String
详情:

列字段名称。该字段必须唯一，否则可能出现未知问题。
默认值: undefined
示例: Column Field

footerFormatter

属性: data-footer-formatter
类型: Function
详情:

函数执行时的上下文（this）指向列对象。

函数接收两个参数：
- data：包含所有行数据的数组。
- value：设置页脚数据时为页脚列的值，否则为 undefined。
函数期望返回 jQuery、String 或 HTMLElement 类型，其他类型将强制转换为 String。

从服务器获取数据并在响应中设置页脚值时，请使用 footerField 选项。
默认值: undefined
示例: Footer Formatter

footerStyle

属性: data-footer-style
类型: Function

详情:

页脚样式格式化函数，接收一个参数：

column：列对象。

支持返回 classes 或 css。示例：

function footerStyle(column) {
  return {
    css: { 'font-weight': 'normal' },
    classes: 'my-class'
  }
}

默认值: {}
示例: Footer Style

formatter

属性: data-formatter
类型: Function
详情:

函数执行时的上下文（this）指向列对象。

单元格格式化函数，接收四个参数：
- value：当前字段的值。
- row：当前行的数据对象。
- index：当前行的索引。
- field：当前字段的名称。
函数期望返回 jQuery、String 或 HTMLElement 类型，其他类型将强制转换为 String。
默认值: undefined
示例: Column Formatter

halign

属性: data-halign
类型: String
详情:

指定如何对齐表格表头。可以使用 'left'、'right'、'center'。
默认值: undefined
示例: Aligning Columns

order

属性: data-order
类型: String
详情:

默认排序顺序，只能是 'asc' 或 'desc'。
默认值: 'asc'
示例: Sort Name Order

radio

属性: data-radio
类型: Boolean
详情:

设为 true 时显示单选框。单选框列具有固定宽度。

如果提供了值，会自动选中该单选框。也可通过 formatter 控制单选框状态（返回 true 选中，返回 false 取消选中）。
默认值: false
示例: Column Radio

rowspan

属性: rowspan | data-rowspan
类型: Number
详情:

指定单元格需要跨越的行数。
默认值: undefined
示例: Rowspan Colspan

searchable

属性: data-searchable
类型: Boolean
详情:

设为 true 时，会在此列上执行搜索。
默认值: true
示例: Column Searchable

searchFormatter

属性: data-search-formatter
类型: Boolean
详情:

设为 true 可以基于格式化后的数据执行搜索。
默认值: true
示例: Search Formatter

searchHighlightFormatter

属性: data-search-highlight-formatter
类型: Boolean|Function
详情:

定义自定义高亮格式化函数，为 search highlight 选项提供高亮功能。
默认值: true
示例: Searchable Highlight Formatter

showSelectTitle

属性: data-show-select-title
类型: Boolean
详情:

设为 true 时，会显示使用 radio 或 singleSelect、checkbox 选项的列标题。
默认值: false
示例: Show Select Title

sortable

属性: data-sortable
类型: Boolean
详情:

设为 true 允许对该列进行排序。
默认值: false
示例: Column Sortable

sorter

属性: data-sorter
类型: Function
详情:

自定义字段排序函数，用于本地排序，接收四个参数：
- fieldA：第一个字段值。
- fieldB：第二个字段值。
- rowA：第一行数据。
- rowB：第二行数据。
预期返回值：-1、0、1。
默认值: undefined
示例: Column Sorter

sortName

属性: data-sort-name
类型: String
详情:

提供自定义排序字段名，替代表头中的默认排序字段或列字段名。例如，列显示字段名为 html 的值（如 <b><span style="color:red">abc</span></b>），但排序使用字段名为 content 的值（'abc'）。
默认值: undefined
示例: Sort Name Order

switchable

属性: data-switchable
类型: Boolean
详情:

设置为 false 可禁用该列的显示/隐藏切换功能。
默认值: true
示例: Column Switchable

switchableLabel

属性: data-switchable-label
类型: String
详情:

列在下拉菜单中对应的切换标签。如果未指定，则使用列标题。
默认值: undefined
示例: Column Switchable

title

属性: data-title
类型: String
详情:

列的标题文本。
默认值: undefined
示例: Column Title

titleTooltip

属性: data-title-tooltip
类型: String
详情:

列标题的提示文本。此选项的值会被应用到 HTML 的 title 属性上。
默认值: undefined
示例: Title Tooltip

valign

属性: data-valign
类型: String
详情:

指定如何对齐单元格数据。可以使用 'top'、'middle'、'bottom'。
默认值: undefined
示例: Aligning Columns

visible

属性: data-visible
类型: Boolean
详情:

设为 false 可隐藏该列。
默认值: true
示例: Column Visible

width

属性: data-width
类型: Number
详情:

列的宽度。未设置时宽度自动扩展以适配内容。但如果表格保持响应式且尺寸过小，可能忽略 'width'（可通过类设置最小/最大宽度等）。默认单位为 px，可通过 widthUnit 修改。
默认值: undefined
示例: Column Width

widthUnit

属性: data-width-unit
类型: String
详情:

定义 width 选项所使用的单位。
默认值: px
示例: Width Unit