列表选项

Bootstrap Table的列选项API。

表选项在jQuery.fn.bootstrapTable.columnDefaults中定义.

field

  • 属性: data-field

  • 类型: String

  • 详情:

    列字段名称。

  • 默认: undefined

  • 示例: 列字段

title

  • 属性: data-title

  • 类型: String

  • 详情:

    列标题文本。

  • 默认: undefined

  • 示例: 列标题

titleTooltip

  • 属性: data-title-tooltip

  • 类型: String

  • 详情:

    列标题工具提示文本。此选项还支持标题HTML属性。

  • 默认: undefined

  • 示例: 标题工具提示

class

  • 属性: class | data-class

  • 类型: String

  • 详情:

    列类名称。

  • 默认: undefined

  • 示例: 列类

width

  • 属性: data-width

  • 类型: Number

  • 详情:

    列的宽度。如果未定义,宽度将自动扩展以适合其内容。虽然如果表格保持响应并且大小太小,则'width' 可能会忽略该表格(通过类等使用min / max-width)。默认使用的单位是'px',widthUnit用来改变它!

  • 默认: undefined

  • 示例: 列宽

widthUnit

  • 属性: data-width-unit

  • 类型: String

  • 详情:

    定义用于选项的单位width.

  • 默认: px

  • 示例: 宽度单位

rowspan

  • 属性: rowspan | data-rowspan

  • 类型: Number

  • 详情:

    指示单元格应占用的行数。

  • 默认: undefined

  • 示例: Rowspan Colspan

colspan

  • 属性: colspan | data-colspan

  • 类型: Number

  • 详情:

    指示单元格应占用的列数。

  • 默认: undefined

  • 示例: Rowspan Colspan

align

  • 属性: data-align

  • 类型: String

  • 详情:

    指示如何对齐列数据。'left', 'right', 'center' 都可以使用。

  • 默认: undefined

  • 示例: Aligning Columns

halign

  • 属性: data-halign

  • 类型: String

  • 详情:

    指示如何对齐表头。'left', 'right', 'center' 都可以使用。

  • 默认: undefined

  • 示例: Aligning Columns

falign

  • 属性: data-falign

  • 类型: String

  • 详情:

    指示如何对齐表格页脚。 'left', 'right', 'center' 都可以使用。

  • 默认: undefined

  • 示例: Aligning Footer

valign

  • 属性: data-valign

  • 类型: String

  • 详情:

    指出如何对齐单元格数据'top', 'middle', 'bottom' 都可以使用。

  • 默认: undefined

  • 示例: Aligning Columns

cellStyle

  • 属性: data-cell-style

  • 类型: Function

  • 详情:

    单元格样式格式化函数,取四个参数:

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

    支持类或css。

  • 默认: undefined

  • 示例: Cell Style

radio

  • 属性: data-radio

  • 类型: Boolean

  • 详情:

    设置true 为显示收音机。无线电列具有固定宽度。

    如果给出了值,则会自动检查复选框。也可以使用格式化程序检查/取消选中无线电(返回true 检查,返回 false 取消选中)。

  • 默认: false

  • 示例: Column Radio

checkbox

  • 属性: data-checkbox

  • 类型: Boolean

  • 详情:

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

    如果给出了值,则会自动检查复选框。也可以通过使用格式化程序来检查/取消选中该复选框(返回true 检查,返回 false 取消选中)。

  • 默认: false

  • 示例: Column Checkbox

checkboxEnabled

clickToSelect

  • 属性: data-click-to-select

  • 类型: Boolean

  • 详情:

    设置true 为在单击行时选择复选框或radiobox。

  • 默认: false

  • 示例: Click to Select

showSelectTitle

  • 属性: data-show-select-title

  • 类型: Boolean

  • 详情:

    设置true 为使用'radio'或'singleSelect''复选框'选项显示列的标题。

  • 默认: false

  • 示例: Show Select Title

sortable

  • 属性: data-sortable

  • 类型: Boolean

  • 详情:

    设置 true为允许列可以排序。

  • 默认: false

  • 示例: Column Sortable

sortName

  • 属性: data-sort-name

  • 类型: String

  • 详情:

    提供可自定义的排序名称,而不是标题中的默认排序名称或列的字段名称。例如,列可能会显示'html'的fieldName值,例如<b><span style="color:red">abc</span></b>,要排序的fieldName是'content',其值为'abc'.

  • 默认: undefined

  • 示例: Sort Name Order

order

  • 属性: data-order

  • 类型: String

  • 详情:

    默认排序顺序,只能是'asc''desc'.

  • 默认: 'asc'

  • 示例: Sort Name Order

sorter

  • 属性: data-sorter

  • 类型: Function

  • 详情:

    用于进行本地排序的自定义字段排序函数,有四个参数:

    • fieldA: 第一个字段值。
    • fieldB: 第二个字段值。
    • rowA: 第一排。
    • rowB: 第二排。
  • 默认: undefined

  • 示例: Column Sorter

visible

  • 属性: data-visible

  • 类型: Boolean

  • 详情:

    设置false 为隐藏列项。

  • 默认: true

  • 示例: Column Visible

switchable

  • 属性: data-switchable

  • 类型: Boolean

  • 详情:

    设置false 为禁用可切换的列项。

  • 默认: true

  • 示例: Column Switchable

cardVisible

  • 属性: data-card-visible

  • 类型: Boolean

  • 详情:

    设置 false 为隐藏卡视图状态中的列项。

  • 默认: true

  • 示例: Card Visible

searchable

  • 属性: data-searchable

  • 类型: Boolean

  • 详情:

    设置true 为搜索此列的数据。

  • 默认: true

  • 示例: Column Searchable

formatter

  • 属性: data-formatter

  • 类型: Function

  • 详情:

    上下文(this)是列Object。

    单元格格式函数,取三个参数:

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

  • 示例: Column Formatter

footerFormatter

  • 属性: data-footer-formatter

  • 类型: Function

  • 详情:

    上下文(this)是列Object。

    该函数,取一个参数:

    • data:所有数据行的数组。

    该函数应返回一个字符串,其中包含要在页脚单元格中显示的文本。

  • 默认: undefined

  • 示例: Footer Formatter

detailFormatter

  • 属性: data-detail-formatter

  • 类型: Function

  • 详情:

    设置为 detailView 和时 detailViewByClick 设置 详细视图的格式 true. 返回a String 并将其附加到详细视图单元格中,可选地使用第三个参数直接渲染元素,该参数是目标单元格的jQuery元素。

    Fallback是表的详细格式化程序。

  • 默认: function(index, row, $element) { return '' }

  • 示例: Detail Formatter

searchFormatter

  • 属性: data-search-formatter

  • 类型: Boolean

  • 详情:

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

  • 默认: true

  • 示例: Search Formatter

escape

  • 属性: data-escape

  • 类型: Boolean

  • 详情:

    转义字符串以插入HTML,替换 &, <, >, “, `, 和 ‘ 字符。

  • 默认: false

  • 示例: Column Escape

events

  • 属性: data-events

  • 类型: Object

  • 详情:

    使用格式化函数时的单元事件监听器,取四个参数:

    • event: jQuery事件。
    • value: 字段值。
    • row: 行记录数据。
    • index: 行索引。

    示例代码:

  <th .. data-events="operateEvent">
  var operateEvents = {
    'click .like': function (e, value, row, index) {}
  }