列选项

Bootstrap 表格的列选项 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

• 属性: data-checkbox-enabled

• 类型: Boolean

• 详情

  将 false 设置为禁用复选框/单选框。

• 默认值: true

• 示例: 复选框已启用 和 复选框已禁用

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 元素。

  回退是表格的 detail-formatter。

• 默认值: 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: 列对象。

  支持 类 或 css。示例用法

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

• 默认值: {}

• 示例: 页脚样式

formatter

• 属性: data-formatter

• 类型: Function

• 详情

  上下文 (this) 是列对象。

  单元格格式化函数，接受四个参数

  • value: 字段值。
  • row: 行记录数据。
  • index: 行索引。
  • field: 行字段。

  预期的返回值数据类型为 jQuery、String 或 HTMLElement。其他类型将被强制转换为 String 类型。

• 默认值: 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

• 详情

  将 true 设置为使用格式化数据进行搜索。

• 默认值: 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

• 详情

  提供一个可自定义的 sort-name，而不是头部中的默认 sort-name，或列的字段名称。例如，列可能显示 'html' 的 fieldName 值，例如 <b><span style="color:red">abc</span></b>，但用于排序的 fieldName 是 '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

• 详情

  列的宽度。如果未定义，宽度将自动扩展以适合其内容。但是，如果表保持响应式并调整为过小尺寸，则此 'width' 可能会被忽略（然后通过类或类似方法使用 min/max-width）。默认使用的单位是 ‘px’。使用 widthUnit 进行更改！

• 默认值: undefined

• 示例： 列宽度

widthUnit

• 属性： data-width-unit

• 类型: String

• 详情

  定义用于 width 选项的单位。

• 默认值： px

• 示例： 宽度单位