Métodos de Bootstrap Table

La API de Métodos de Bootstrap Table.

En esta página

La sintaxis de llamada de métodos: $('#table').bootstrapTable('method', parameter).

Nota: Los nombres de métodos a continuación (por ejemplo, append, check, getData) son nombres exactos de métodos que se usan al llamar a los métodos de Bootstrap Table a través de JavaScript.

Por ejemplo: $('#table').bootstrapTable('append', data)

append

Parámetro: data
Detalle:

Agregar los data a la tabla.
Ejemplo: Append

check

Parámetro: index
Detalle:

Marcar una fila. El index de la fila comienza en 0.
Ejemplo: Check/Uncheck

checkAll

Parámetro: undefined
Detalle:

Marcar todas las filas de la página actual.
Ejemplo: Check/Uncheck All

checkBy

Parámetro: params
Detalle:

Marcar una fila por una matriz de valores, los params contienen:
- field: nombre del campo usado para encontrar registros.
- values: matriz de valores para filas a marcar.
- onlyCurrentPage (default false): Si true, solo el conjunto de datos visible será marcado. Si se usa paginación, las otras páginas serán ignoradas.
Ejemplo: Check/Uncheck By

checkInvert

Parámetro: undefined
Detalle:

Invertir la marca de las filas de la página actual. Dispara eventos onCheckSome y onUncheckSome.
Ejemplo: Check Invert

collapseAllRows

Parámetro: undefined
Detalle:

Colapsar todas las filas si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse All Rows

collapseRow

Parámetro: index
Detalle:

Colapsar la fila con el index pasado por parámetro si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse Row

collapseRowByUniqueId

Parámetro: uniqueId
Detalle:

Colapsar la fila con el uniqueId pasado por parámetro si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse Row by uniqueId

destroy

Parámetro: undefined
Detalle:

Destruir la Bootstrap Table.
Ejemplo: Destroy

expandAllRows

Parámetro: undefined
Detalle:

Expandir todas las filas si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse All Rows

expandRow

Parámetro: index
Detalle:

Expandir la fila que tiene el index pasado por parámetro si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse Row

expandRowByUniqueId

Parámetro: uniqueId
Detalle:

Expandir la fila con el uniqueId pasado por parámetro si la opción de vista de detalles está establecida en true.
Ejemplo: Expand/Collapse Row by uniqueId

filterBy

Parámetro:
- filter - Un objeto de filtro Por defecto: {}
- options - Un objeto de opciones Por defecto:
```
{
    'filterAlgorithm': 'and'
}
```
Detalle:

(Solo se puede usar en el lado del cliente) Filtrar datos en la tabla. Hay múltiples formas de filtrar:
- Dejar las opciones en blanco para usar el filtro and.
- Establecer el filterAlgorithm (ver en parámetro) en or para usar el filtro or.
- Pasar una función al filterAlgorithm (ver en parámetro) para usar un filtro custom.
Algoritmo de filtrado
- And
  - Filtrar {age: 10} para mostrar solo los datos cuya edad sea igual a 10. También puede filtrar con una matriz de valores, como en: {age: 10, hairColor: ['blue', 'red', 'green']} para encontrar datos donde la edad sea igual a 10 y el color del pelo sea azul, rojo o verde.
- Or
  - Filtrar {age: 10, name: "santa"} para mostrar todos los datos que tengan una edad de 10 o el nombre sea igual a santa.
- Custom
  - Filtrar por tu algoritmo personalizado
  - Parámetros de la función:
    - Row
    - Filters
  - Devolver true para mantener la fila y false para filtrar la fila.
Ejemplo: Filter By

getData

Parámetro: params
Detalle:

Obtener los datos cargados de la tabla en el momento en que se llama a este método
- useCurrentPage: si se establece en true, el método devolverá solo los datos de la página actual.
- includeHiddenRows: si se establece en true, el método incluirá las filas ocultas.
- unfiltered: si se establece en true, el método incluirá todos los datos (sin filtrar).
- formatted: obtener el valor formateado del formatter definido.
Ejemplo: Get Data

getFooterData

Parámetro: undefined
Detalle:

Obtener los datos cargados del pie en el momento en que se llama a este método
Ejemplo: Get Footer Data

getHiddenColumns

Parámetro: undefined
Detalle:

Obtener columnas ocultas.
Ejemplo: Get Visible/Hidden Columns

getHiddenRows

Parámetro: show
Detalle:

Obtener todas las filas ocultas, y si pasas el parámetro show como true, las filas se mostrarán nuevamente. De lo contrario, el método solo devolverá las filas ocultas.
Ejemplo: Get Hidden Rows

getOptions

Parámetro: undefined
Detalle:

Devolver el objeto de opciones.
Ejemplo: Get Options

getRowByUniqueId

Parámetro: id
Detalle:

Obtener datos de la tabla, la fila que contiene el id pasado por parámetro.
Ejemplo: Get Row By Unique Id

getScrollPosition

Parámetro: undefined
Detalle:

Obtener la posición actual del scroll. La unidad es 'px'.
Ejemplo: Get Scroll Position

getSelections

Parámetro: undefined
Detalle:

Devolver filas seleccionadas. Cuando no se selecciona ningún registro, se devolverá una matriz vacía. Las filas seleccionadas se deseleccionarán durante algunas acciones, por ejemplo, búsqueda o cambio de página. Si quieres mantener las selecciones, por favor usa maintainMetaData.
Ejemplo: Get Selections

getVisibleColumns

Parámetro: -
Detalle:

Obtener columnas visibles.
Ejemplo: Get Visible/Hidden Columns

hideAllColumns

Parámetro: undefined
Detalle:

Ocultar todas las columnas.
Ejemplo: Show/Hide All Columns

hideColumn

Parámetro: field
Detalle:

Ocultar la columna field especificada. El parámetro puede ser una cadena o una matriz de campos.
Ejemplo: Show/Hide Column

hideLoading

Parámetro: undefined
Detalle:

Ocultar estado de carga.
Ejemplo: Show/Hide Loading

hideRow

Parámetro: params
Detalle:

Ocultar la fila especificada. Los params deben contener al menos una de las siguientes propiedades:
- index: el índice de la fila.
- uniqueId: el valor del uniqueId para esa fila.
Ejemplo: Show/Hide Row

insertRow

Parámetro: params
Detalle:

Insertar una nueva fila. Los params contienen las siguientes propiedades:
- index: el índice de fila donde insertar.
- row: los datos de la fila.
Ejemplo: Insert Row

load

Parámetro: data
Detalle:

Cargar los data en la tabla. Las filas antiguas serán eliminadas.
Ejemplo: Load

mergeCells

Parámetro: params
Detalle:

Fusionar algunas celdas en una sola celda. Los params contienen las siguientes propiedades:
- index: el índice de la fila.
- field: el nombre del campo.
- rowspan: el número de filas a fusionar.
- colspan: el número de columnas a fusionar.
Ejemplo: Merge Cells

Parámetro: undefined
Detalle:

Ir a la página siguiente.
Ejemplo: Select/Prev/Next Page

prepend

Parámetro: data
Detalle:

Agregar los data al principio de la tabla.
Ejemplo: Prepend

Parámetro: undefined
Detalle:

Ir a la página anterior.
Ejemplo: Select/Prev/Next Page

refresh

Parámetro: params
Detalle:

Actualizar/recargar los datos del servidor remoto. Admite las siguientes configuraciones de parámetros:
- silent (por defecto: false): Establecer en true para actualizar datos silenciosamente sin mostrar el estado de carga.
- url: Opcional, anular temporalmente la URL de solicitud actual.
- pageNumber: Opcional, especificar el número de página al que navegar.
- pageSize: Opcional, especificar el número de registros a mostrar por página.
- query: Opcional, agregar parámetros de consulta adicionales para esta solicitud.
Ejemplo de uso:
```
// Actualización silenciosa
$('#table').bootstrapTable('refresh', {silent: true})

// Modificar URL y parámetros de paginación
$('#table').bootstrapTable('refresh', {
  url: '/new/api/endpoint',
  pageNumber: 2,
  pageSize: 20
})

// Agregar parámetros de consulta
$('#table').bootstrapTable('refresh', {
  query: {status: 'active', category: 'electronics'}
})
```
Ejemplo: Refresh

refreshOptions

Parámetro: options
Detalle:

Actualizar las options de la tabla.
Ejemplo: Refresh Options

remove

Parámetro: params
Detalle:

Eliminar datos de la tabla. Los params contienen las siguientes propiedades:
- field: El nombre del campo usado para hacer coincidir las filas a eliminar. Puedes usar el campo especial $index para eliminar filas por índice de fila.
- values: Una matriz de valores de campo para las filas a eliminar. Si usas el campo especial $index, puedes pasar una matriz de índices de fila.
Ejemplos de uso:
```
// Eliminar por campo id
$('#table').bootstrapTable('remove', {
  field: 'id',
  values: [1, 2, 3]
})

// Eliminar por índice de fila (comienza en 0)
$('#table').bootstrapTable('remove', {
  field: '$index',
  values: [0, 2, 4]
})

// Eliminar por otro campo
$('#table').bootstrapTable('remove', {
  field: 'name',
  values: ['John', 'Jane']
})
```
Ejemplo: Remove

removeAll

Parámetro: undefined
Detalle:

Eliminar todos los datos de la tabla.
Ejemplo: Remove All

removeByUniqueId

Parámetro: id
Detalle:

Eliminar datos de la tabla, la fila que contiene el id pasado por parámetro.
Ejemplo: Remove By Unique Id

resetSearch

Parámetro: text
Detalle:

Establecer el text de búsqueda.
Ejemplo: Reset Search

resetView

Parámetro: params
Detalle:

Restablecer la vista de Bootstrap Table. Por ejemplo, restablecer la altura de la tabla, los params contienen:
- height: la altura de la tabla.
Ejemplo: Reset View

scrollTo

Parámetro: value|object
Detalle:
- value
  - Desplazarse a la posición value numérica, la unidad es 'px', establecer 'bottom' significa desplazarse al fondo.
- object
  - Desplazarse a la unidad (px o rows (el índice comienza en 0)) Por defecto: {unit: 'px', value: 0}
Ejemplo: Scroll To

selectPage

Parámetro: page
Detalle:

Ir a la page especificada.
Ejemplo: Select/Prev/Next Page

showAllColumns

Parámetro: undefined
Detalle:

Mostrar todas las columnas.
Ejemplo: Show/Hide All Columns

showColumn

Parámetro: field
Detalle:

Mostrar la columna field especificada. El parámetro puede ser una cadena o una matriz de campos.
Ejemplo: Show/Hide Column

showLoading

Parámetro: undefined
Detalle:

Mostrar estado de carga.
Ejemplo: Show/Hide Loading

showRow

Parámetro: params
Detalle:

Mostrar la fila especificada. Los params deben contener al menos una de las siguientes propiedades:
- index: el índice de la fila.
- uniqueId: el valor del uniqueId para esa fila.
Ejemplo: Show/Hide Row

sortBy

Parámetro: params
Detalle:

Ordenar la tabla por el campo especificado. Los params deben contener al menos una de las siguientes propiedades:
- field: el nombre del campo.
- sortOrder: el orden de clasificación, solo puede ser ‘asc’ o ‘desc’.
Ejemplo: Sort By

sortReset

Parámetro: undefined
Detalle:

Restablecer el estado de clasificación de la tabla independientemente de si fue causado por el usuario o mediante programación.
Ejemplo: Sort reset

toggleDetailView

Parámetro: index
Detalle:

Alternar la fila que tiene el index pasado por parámetro si la opción de vista de detalles está establecida en true.
Ejemplo: Toggle Detail View

toggleFullscreen

Parámetro: undefined
Detalle:

Alternar pantalla completa.
Ejemplo: Toggle Fullscreen

togglePagination

Parámetro: undefined
Detalle:

Alternar la opción de paginación.
Ejemplo: Toggle Pagination

toggleView

Parámetro: undefined
Detalle:

Alternar entre vista de tarjeta/tabla.
Ejemplo: Toggle View

uncheck

Parámetro: index
Detalle:

Desmarcar una fila. El index de la fila comienza en 0.
Ejemplo: Check/Uncheck

uncheckAll

Parámetro: undefined
Detalle:

Desmarcar todas las filas de la página actual.
Ejemplo: Check/Uncheck All

uncheckBy

Parámetro: params
Detalle:

Desmarcar una fila por una matriz de valores. Los params contienen:
- field: nombre del campo usado para encontrar registros.
- values: matriz de valores para filas a desmarcar.
- onlyCurrentPage (default false): Si true, solo el conjunto de datos visible será desmarcado. Si se usa paginación, las otras páginas serán ignoradas.
Ejemplo: Check/Uncheck By

updateByUniqueId

Parámetro: params
Detalle:

Actualizar la(s) fila(s) especificada(s). Cada param contiene las siguientes propiedades:
- id: un id de fila donde el id debe ser el campo uniqueId asignado a la tabla.
- row: los nuevos datos de la fila.
- replace (opcional): establecer en true para reemplazar la fila en lugar de extenderla.
Ejemplo: Update By Unique Id

updateCell

Parámetro: params
Detalle:

Actualizar una celda. Los params contienen las siguientes propiedades:
- index: el índice de la fila.
- field: el nombre del campo.
- value: el nuevo valor del campo.
Para deshabilitar la re-inicialización de la tabla, puedes establecer {reinit: false}.
Ejemplo: Update Cell

updateCellByUniqueId

Parámetro: params
Detalle:

Actualizar la(s) celda(s) especificada(s). Cada param contiene las siguientes propiedades:
- id: id de fila donde el id debe ser el campo uniqueId asignado a la tabla.
- field: nombre del campo de la celda a actualizar.
- value: el nuevo valor de la celda.
Para deshabilitar la re-inicialización de la tabla, puedes establecer {reinit: false}.
Ejemplo: Update Cell By Unique Id

updateColumnTitle

Parámetro: params
Detalle:

Actualizar el título del campo de la columna. Los params contienen las siguientes propiedades:
- field: el nombre del campo.
- title: el título del campo.
Ejemplo: Update Column Title

updateFormatText

Parámetro: formatName, text
Detalle:

Actualizar el texto de formato de localizaciones.
Ejemplo: Update Format Text

updateRow

Parámetro: params
Detalle:

Actualizar la(s) fila(s) especificada(s). Cada param contiene las siguientes propiedades:
- index: el índice de la fila a actualizar.
- row: los nuevos datos de la fila.
- replace (opcional): establecer en true para reemplazar la fila en lugar de extenderla.
Ejemplo: Update Row