列选项
Bootstrap Table 的列选项 API。
列选项在 jQuery.fn.bootstrapTable.columnDefaults
中定义。
align
-
属性:
data-align
-
类型:
String
-
详情:
指示如何对齐列数据。可以使用
'left'
(左)、'right'
(右)、'center'
(居中)。 -
默认值:
undefined
-
示例: 对齐列
cardVisible
-
属性:
data-card-visible
-
类型:
Boolean
-
详情:
设置为
false
以在卡片视图状态下隐藏列项。 -
默认值:
true
-
示例: 卡片可见性
cellStyle
-
属性:
data-cell-style
-
类型:
Function
-
详情:
单元格样式格式化函数,接受四个参数:
value
:字段值。row
:行记录数据。index
:行索引。field
:行字段。
支持类或 CSS。
-
默认值:
undefined
-
示例: 单元格样式
checkbox
-
属性:
data-checkbox
-
类型:
Boolean
-
详情:
设置为
true
以显示复选框。复选框列具有固定宽度。如果给定值,复选框将自动被选中。 还可以通过使用格式化器来选中/取消选中复选框(返回
true
选中,返回false
取消选中)。 -
默认值:
false
-
示例: 列复选框
checkboxEnabled
class
-
属性:
class | data-class
-
类型:
String
-
详情:
列的类名。
-
默认值:
undefined
-
示例: 列类
clickToSelect
-
属性:
data-click-to-select
-
类型:
Boolean
-
详情:
设置为
true
以在点击行时选择复选框或单选框。 -
默认值:
true
-
示例: 点击选择
colspan
-
属性:
colspan | data-colspan
-
类型:
Number
-
详情:
指示单元格应占用的列数。
-
默认值:
undefined
-
示例: 行跨度和列跨度
detailFormatter
-
属性:
data-detail-formatter
-
类型:
Function
-
详情:
当
detailView
和detailViewByClick
设置为true
时格式化详细视图。返回一个String
,它将被追加到详细视图单元格中,可以选择使用第三个参数直接渲染元素,该参数是目标单元格的 jQuery 元素。回退为表格的详细格式化器。
-
默认值:
function(index, row, $element) { return '' }
-
示例: 详细格式化器
escape
-
属性:
data-escape
-
类型:
Boolean
-
详情:
转义要插入 HTML 的字符串,替换 &、<、>、”、`、和 ‘ 字符。
-
默认值:
undefined
-
示例: 列转义
events
-
属性:
data-events
-
类型:
Object
-
详情:
单元格事件监听器,当使用格式化函数时,接受四个参数:
event
:jQuery 事件。value
:字段值。row
:行记录数据。index
:行索引。
示例代码:
<th .. data-events="operateEvent">
var operateEvents = {
'click .like': function (e, value, row, index) {}
}
-
默认值:
undefined
-
示例: 列事件
falign
-
属性:
data-falign
-
类型:
String
-
详情:
指示如何对齐表格页脚。可以使用
'left'
(左)、'right'
(右)、'center'
(居中)。 -
默认值:
undefined
-
示例: 对齐页脚
field
-
属性:
data-field
-
类型:
String
-
详情:
列字段名称。此字段必须唯一,否则可能会出现一些未知问题。
-
默认值:
undefined
-
示例: 列字段
footerFormatter
-
属性:
data-footer-formatter
-
类型:
Function
-
详情:
上下文(this)是列对象。
该函数接受两个参数:
data
:所有数据行的数组。value
:如果设置了页脚数据,则为页脚列的值。
预期的返回数据类型是
jQuery
、String
或HTMLElement
。其他类型将被强制转换为String
类型。如果从服务器获取数据并从服务器响应设置页脚值,请使用
footerField
选项。 -
默认值:
undefined
-
示例: 页脚格式化器
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
-
详情:
单元格格式化函数,接受三个参数:
value
:字段值。row
:行记录数据。index
:行索引。
支持
classes
或css
。 -
默认值:
undefined
-
示例: 格式化器
halign
-
属性:
data-halign
-
类型:
String
-
详情:
指示如何对齐表格标题。可以使用
'left'
、'right'
、'center'
。 -
默认值:
undefined
-
示例: 对齐列
order
-
属性:
data-order
-
类型:
String
-
详情:
默认排序顺序,只能是
'asc'
或'desc'
。 -
默认值:
'asc'
-
示例: 排序名称顺序
radio
-
属性:
data-radio
-
类型:
Boolean
-
详情:
设置为
true
以显示单选按钮。单选列具有固定宽度。如果给定值,单选按钮将自动被选中。 还可以通过使用格式化器来选中/取消选中单选按钮(返回
true
选中,返回false
取消选中)。 -
默认值:
false
-
示例: 列单选
rowspan
-
属性:
rowspan | data-rowspan
-
类型:
Number
-
详情:
指示单元格应占用的行数。
-
默认值:
undefined
-
示例: 行跨度和列跨度
searchable
-
属性:
data-searchable
-
类型:
Boolean
-
详情:
设置为
true
以搜索此列的数据。 -
默认值:
true
-
示例: 列可搜索
searchFormatter
-
属性:
data-search-formatter
-
类型:
Boolean
-
详情:
设置为
false
以禁用搜索格式化器。 -
默认值:
true
-
示例: 搜索格式化器
searchHighlightFormatter
-
属性:
data-search-highlight-formatter
-
类型:
Boolean|Function
-
详情:
定义一个
function
以使用自定义高亮格式化器用于 搜索高亮 选项。 -
默认值:
true
-
示例: 可搜索高亮格式化器
showSelectTitle
-
属性:
data-show-select-title
-
类型:
Boolean
-
详情:
设置为
true
以显示带有 ‘radio’ 或 ‘singleSelect’ ‘checkbox’ 选项的列标题。 -
默认值:
false
-
示例: 显示选择标题
sortable
-
属性:
data-sortable
-
类型:
Boolean
-
详情:
设置为
true
以允许对此列进行排序。 -
默认值:
false
-
示例: 可排序
sorter
-
属性:
data-sorter
-
类型:
Function
-
详情:
用于执行本地排序的自定义字段排序函数,接受四个参数:
fieldA
:第一个字段值。fieldB
:第二个字段值。rowA
:第一个行。rowB
:第二个行。
预期返回值:
-1, 0, 1
。 -
默认值:
undefined
-
示例: 列排序器
sortName
-
属性:
data-sort-name
-
类型:
String
-
详情:
提供一个可自定义的排序名称,而不是默认的列头排序名称或列字段名称。例如,列可能显示 ‘html’ 字段值的 ‘abc’,但排序字段是 ‘content’ 值 ‘abc’。
-
默认值:
undefined
-
示例: 排序名称
switchable
-
属性:
data-switchable
-
类型:
Boolean
-
详情:
设置为
false
以禁用列切换下拉菜单中的列。 -
默认值:
true
-
示例: 可切换
switchableLabel
-
属性:
data-switchable-label
-
类型:
String
-
详情:
列切换下拉菜单中的列标签。如果未指定,则使用列标题。
-
默认值:
undefined
-
示例: 可切换
title
-
属性:
data-title
-
类型:
String
-
详情:
列标题文本。
-
默认值:
undefined
-
示例: 标题
titleTooltip
-
属性:
data-title-tooltip
-
类型:
String
-
详情:
列标题工具提示文本。此选项还支持标题 HTML 属性。
-
默认值:
undefined
-
示例: 标题工具提示
valign
-
属性:
data-valign
-
类型:
String
-
详情:
指示如何对齐单元格数据。可以使用
'top'
、'middle'
、'bottom'
。 -
默认值:
undefined
-
示例: 对齐列
visible
-
属性:
data-visible
-
类型:
Boolean
-
详情:
设置为
false
以隐藏列项。 -
默认值:
true
-
示例: 可见性
width
-
属性:
data-width
-
类型:
Number, String
-
详情:
指定列的宽度。可以使用百分比或像素值。
-
默认值:
undefined
-
示例: 宽度
widthUnit
-
属性:
data-width-unit
-
类型:
String
-
详情:
定义用于选项
width
的单位。 -
默认值:
px
-
示例: 宽度单位
height
-
属性:
data-height
-
类型:
Number
-
详情:
指定列的高度。
-
默认值:
undefined
-
示例: 列高度
key
-
属性:
data-key
-
类型:
Boolean
-
详情:
设置为
true
以将列标记为键列。 -
默认值:
false
-
示例: 键列
keyEvents
-
属性:
data-key-events
-
类型:
Object
-
详情:
键事件监听器,接受四个参数:
event
:jQuery 事件。value
:字段值。row
:行记录数据。index
:行索引。
-
默认值:
undefined
-
示例: 键事件
maxWidth
-
属性:
data-max-width
-
类型:
Number
-
详情:
指定列的最大宽度。
-
默认值:
undefined
-
示例: 最大宽度
minWidth
-
属性:
data-min-width
-
类型:
Number
-
详情:
指定列的最小宽度。
-
默认值:
undefined
-
示例: 最小宽度
searchHighlight
-
属性:
data-search-highlight
-
类型:
Boolean
-
详情:
设置为
true
以高亮显示搜索关键词。 -
默认值:
false
-
示例: 搜索高亮