Eventos de Bootstrap Table

La API de eventos de Bootstrap Table.

Los eventos se pueden enlazar de dos maneras:

• a través del objeto de opciones
• a través del manejador de eventos jQuery

Enlazando a través del objeto de opciones:

// Aquí, puedes esperar tener como último parámetro el objeto bootstrap-table

$('#table').bootstrapTable({
  onEventName: function (arg1, arg2, ...) {
    // ...
  }
})

Enlazando a través del manejador de eventos jQuery:

// Aquí, puedes esperar tener en la variable 'e' la propiedad sender, que es el objeto bootstrap-table

$('#table').on('event-name.bs.table', function (e, arg1, arg2, ...) {
  // ...
})

Consejo: si usas el manejador de eventos jQuery, ¡asegúrate de enlazar el listener del evento antes de que se ejecute el evento!

Nota: Los nombres de eventos a continuación (por ejemplo, onCheck, onClickRow, onLoadSuccess) son nombres exactos de eventos para usar al enlazar eventos a través de JavaScript.

onAll

• Evento jQuery: all.bs.table

• Parámetro: name, args

• Detalle:

  Se dispara cuando cualquier evento se activa. Los parámetros contienen:

  • name: el nombre del evento,
  • args: los datos del evento.

onCheck

• Evento jQuery: check.bs.table

• Parámetro: row, $element

• Detalle:

  Se dispara cuando el usuario marca una fila. Los parámetros contienen:

  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento DOM marcado.

onCheckAll

• Evento jQuery: check-all.bs.table

• Parámetro: rowsAfter, rowsBefore

• Detalle:

  Se dispara cuando el usuario marca todas las filas. Los parámetros contienen:

  • rowsAfter: matriz de registros de las filas ahora marcadas.
  • rowsBefore: matriz de registros de las filas marcadas anteriormente.

onCheckSome

• Evento jQuery: check-some.bs.table

• Parámetro: rows

• Detalle:

  Se dispara cuando el usuario marca algunas filas. Los parámetros contienen:

  • rows: matriz de registros correspondientes a las filas recién marcadas.

onClickCell

• Evento jQuery: click-cell.bs.table

• Parámetro: field, value, row, $element

• Detalle:

  Se dispara cuando el usuario hace clic en una celda. Los parámetros contienen:

  • field: el nombre del campo correspondiente a la celda clicada.
  • value: el valor de datos correspondiente a la celda clicada.
  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento td.

onClickRow

• Evento jQuery: click-row.bs.table

• Parámetro: row, $element, field

• Detalle:

  Se dispara cuando el usuario hace clic en una fila. Los parámetros contienen:

  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento tr.
  • field: el nombre del campo correspondiente a la celda clicada.

onCollapseRow

• Evento jQuery: collapse-row.bs.table

• Parámetro: index, row, detailView

• Detalle:

  Se dispara cuando haces clic en el icono de detalle para contraer la vista de detalle. Los parámetros contienen:

  • index: el índice de la fila contraída.
  • row: el registro correspondiente a la fila contraída.
  • detailView: la vista de detalle contraída.

onColumnSwitch

• Evento jQuery: column-switch.bs.table

• Parámetro: field, checked

• Detalle:

  Se dispara cuando se cambia la visibilidad de la columna (showColumns). Los parámetros contienen:

  • field: el nombre del campo correspondiente a la columna cambiada.
  • checked: el estado marcado de la columna.

onColumnSwitchAll

• Evento jQuery: column-switch-all.bs.table

• Parámetro: checked

• Detalle:

  Se dispara cuando se alternan todas las columnas. Los parámetros contienen:

  • checked: el estado marcado de la columna.

onDblClickCell

• Evento jQuery: dbl-click-cell.bs.table

• Parámetro: field, value, row, $element

• Detalle:

  Se dispara cuando el usuario hace doble clic en una celda. Los parámetros contienen:

  • field: el nombre del campo correspondiente a la celda clicada.
  • value: el valor de datos correspondiente a la celda clicada.
  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento td.

onDblClickRow

• Evento jQuery: dbl-click-row.bs.table

• Parámetro: row, $element, field

• Detalle:

  Se dispara cuando el usuario hace doble clic en una fila. Los parámetros contienen:

  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento tr.
  • field: el nombre del campo correspondiente a la celda clicada.

onExpandRow

• Evento jQuery: expand-row.bs.table

• Parámetro: index, row, $detail

• Detalle:

  Se dispara cuando haces clic en el icono de detalle para expandir la vista de detalle. Los parámetros contienen:

  • index: el índice de la fila expandida.
  • row: el registro correspondiente a la fila expandida.
  • $detail: el elemento DOM del div de detalle después del elemento tr actual, puedes usar métodos jQuery para personalizar las vistas de detalle.

onLoadError

• Evento jQuery: load-error.bs.table

• Parámetro: status, jqXHR

• Detalle:

  Se dispara cuando ocurren errores al cargar datos remotos. Los parámetros contienen:

  • status: el código de estado de jqXHR.
  • jqXHR: objeto jqXHR, que es un super conjunto del objeto XMLHTTPRequest. Para obtener más información, consulta el Tipo jqXHR.

onLoadSuccess

• Evento jQuery: load-success.bs.table

• Parámetro: data

• Detalle:

  Se dispara cuando los datos remotos se cargan correctamente. Los parámetros contienen:

  • data: los datos remotos cargados en la tabla. (Nota: estos datos no se pueden modificar una vez que se han cargado en la tabla. Si necesitas procesar los datos recibidos antes de usarlos en la tabla, escribe tu propio responseHandler en su lugar.)
  • status: el código de estado de jqXHR.
  • jqXHR: objeto jqXHR, que es un super conjunto del objeto XMLHTTPRequest. Para obtener más información, consulta el Tipo jqXHR.

onPageChange

• Evento jQuery: page-change.bs.table

• Parámetro: number, size

• Detalle:

  Se dispara al cambiar el número de página o el tamaño de página. Los parámetros contienen:

  • number: el número de página.
  • size: el tamaño de página.

onPostBody

• Evento jQuery: post-body.bs.table

• Parámetro: data

• Detalle:

  Se dispara después de que el cuerpo de la tabla se renderiza y está disponible en el DOM. Los parámetros contienen:

  • data: los datos renderizados.

onPostFooter

• Evento jQuery: post-footer.bs.table

• Parámetro: $tableFooter

• Detalle:

  Se dispara después de que el pie se renderiza y está disponible en el DOM. Los parámetros contienen:

  • $tableFooter: el elemento DOM del pie.

onPostHeader

• Evento jQuery: post-header.bs.table

• Parámetro: undefined

• Detalle:

  Se dispara después de que el encabezado de la tabla se renderiza y está disponible en el DOM.

onPreBody

• Evento jQuery: pre-body.bs.table

• Parámetro: data

• Detalle:

  Se dispara antes de que el cuerpo de la tabla se renderice. Los parámetros contienen:

  • data: los datos renderizados.

onRefresh

• Evento jQuery: refresh.bs.table

• Parámetro: params

• Detalle:

  Se dispara después del clic en el botón de actualización. Los parámetros contienen:

  • params: los parámetros adicionales solicitados al servidor.

onRefreshOptions

• Evento jQuery: refresh-options.bs.table

• Parámetro: options

• Detalle:

  Se dispara después de actualizar las opciones, y antes de destruir e inicializar la tabla. Los parámetros contienen:

  • options: el objeto de opciones de la tabla.

onResetView

• Evento jQuery: reset-view.bs.table

• Parámetro: undefined

• Detalle:

  Se dispara al restablecer la vista de la tabla.

onScrollBody

• Evento jQuery: scroll-body.bs.table

• Parámetro: $tableBody

• Detalle:

  Se dispara cuando el cuerpo de la tabla se desplaza.

onSearch

• Evento jQuery: search.bs.table

• Parámetro: text

• Detalle:

  Se dispara al buscar en la tabla. Los parámetros contienen:

  • text: el texto de la entrada de búsqueda.

onSort

• Evento jQuery: sort.bs.table

• Parámetro: name, order

• Detalle:

  Se dispara cuando el usuario ordena una columna. Los parámetros contienen:

  • name: el nombre del campo de la columna ordenada.
  • order: el orden de la columna ordenada.

onToggle

• Evento jQuery: toggle.bs.table

• Parámetro: cardView

• Detalle:

  Se dispara al alternar la vista de la tabla. Los parámetros contienen:

  • cardView: el estado cardView de la tabla.

onTogglePagination

• Evento jQuery: toggle-pagination.bs.table

• Parámetro: state

• Detalle:

  Se dispara cuando se alterna la paginación:

  • state: el nuevo estado de paginación (true-> Paginación habilitada, false -> Paginación deshabilitada )

onUncheck

• Evento jQuery: uncheck.bs.table

• Parámetro: row, $element

• Detalle:

  Se dispara cuando el usuario desmarca una fila. Los parámetros contienen:

  • row: el registro correspondiente a la fila clicada.
  • $element: el elemento DOM desmarcado.

onUncheckAll

• Evento jQuery: uncheck-all.bs.table

• Parámetro: rowsAfter, rowsBefore

• Detalle:

  Se dispara cuando el usuario desmarca todas las filas. Los parámetros contienen:

  • rowsAfter: matriz de registros de las filas ahora marcadas.
  • rowsBefore: matriz de registros de las filas marcadas anteriormente.

onUncheckSome

• Evento jQuery: uncheck-some.bs.table

• Parámetro: rows

• Detalle:

  Se dispara cuando el usuario desmarca algunas filas. Los parámetros contienen:

  • rows: matriz de registros correspondientes a las filas anteriormente marcadas.

onVirtualScroll

• Evento jQuery: virtual-scroll.bs.table

• Parámetro: startIndex, endIndex

• Detalle:

  Se dispara cuando el usuario desplaza el scroll virtual. Los parámetros contienen:

  • startIndex: el índice de fila inicial del scroll virtual.
  • endIndex: el índice de fila final del scroll virtual.