Bootstrap Table Events

L'API des événements de Bootstrap Table.

Les événements peuvent être liés de deux manières :

• via l’objet d’options
• via le gestionnaire d’événements jQuery

Liaison via l’objet d’options :

// Ici, vous pouvez vous attendre à avoir en dernier paramètre l'objet bootstrap-table

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

Liaison via le gestionnaire d’événements jQuery :

// Ici, vous pouvez vous attendre à avoir dans la variable 'e' la propriété sender, qui est l'objet bootstrap-table

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

Astuce : si vous utilisez le gestionnaire d’événements jQuery, assurez-vous de lier l’écouteur d’événement avant que l’événement ne soit exécuté !

Remarque : Les noms d’événements ci-dessous (par exemple, onCheck, onClickRow, onLoadSuccess) sont des noms d’événements exacts à utiliser lors de la liaison d’événements via JavaScript.

onAll

• Événement jQuery : all.bs.table

• Paramètre : name, args

• Détail :

  Il se déclenche lorsque n’importe quel événement se déclenche. Les paramètres contiennent :

  • name : le nom de l’événement,
  • args : les données de l’événement.

onCheck

• Événement jQuery : check.bs.table

• Paramètre : row, $element

• Détail :

  Il se déclenche lorsque l’utilisateur coche une ligne. Les paramètres contiennent :

  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément DOM coché.

onCheckAll

• Événement jQuery : check-all.bs.table

• Paramètre : rowsAfter, rowsBefore

• Détail :

  Il se déclenche lorsque l’utilisateur coche toutes les lignes. Les paramètres contiennent :

  • rowsAfter : tableau d’enregistrements des lignes maintenant cochées.
  • rowsBefore : tableau d’enregistrements des lignes cochées auparavant.

onCheckSome

• Événement jQuery : check-some.bs.table

• Paramètre : rows

• Détail :

  Il se déclenche lorsque l’utilisateur coche certaines lignes. Les paramètres contiennent :

  • rows : tableau d’enregistrements correspondant aux nouvelles lignes cochées.

onClickCell

• Événement jQuery : click-cell.bs.table

• Paramètre : field, value, row, $element

• Détail :

  Il se déclenche lorsque l’utilisateur clique sur une cellule. Les paramètres contiennent :

  • field : le nom du champ correspondant à la cellule cliquée.
  • value : la valeur de données correspondant à la cellule cliquée.
  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément td.

onClickRow

• Événement jQuery : click-row.bs.table

• Paramètre : row, $element, field

• Détail :

  Il se déclenche lorsque l’utilisateur clique sur une ligne. Les paramètres contiennent :

  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément tr.
  • field : le nom du champ correspondant à la cellule cliquée.

onCollapseRow

• Événement jQuery : collapse-row.bs.table

• Paramètre : index, row, detailView

• Détail :

  Il se déclenche lorsque vous cliquez sur l’icône de détail pour réduire la vue détaillée. Les paramètres contiennent :

  • index : l’indice de la ligne réduite.
  • row : l’enregistrement correspondant à la ligne réduite.
  • detailView : la vue détaillée réduite.

onColumnSwitch

• Événement jQuery : column-switch.bs.table

• Paramètre : field, checked

• Détail :

  Il se déclenche lors du basculement de la visibilité de la colonne (showColumns). Les paramètres contiennent :

  • field : le nom du champ correspondant à la colonne basculée.
  • checked : l’état coché de la colonne.

onColumnSwitchAll

• Événement jQuery : column-switch-all.bs.table

• Paramètre : checked

• Détail :

  Il se déclenche lors du basculement de toutes les colonnes. Les paramètres contiennent :

  • checked : l’état coché de la colonne.

onDblClickCell

• Événement jQuery : dbl-click-cell.bs.table

• Paramètre : field, value, row, $element

• Détail :

  Il se déclenche lorsque l’utilisateur double-clique sur une cellule. Les paramètres contiennent :

  • field : le nom du champ correspondant à la cellule cliquée.
  • value : la valeur de données correspondant à la cellule cliquée.
  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément td.

onDblClickRow

• Événement jQuery : dbl-click-row.bs.table

• Paramètre : row, $element, field

• Détail :

  Il se déclenche lorsque l’utilisateur double-clique sur une ligne. Les paramètres contiennent :

  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément tr.
  • field : le nom du champ correspondant à la cellule cliquée.

onExpandRow

• Événement jQuery : expand-row.bs.table

• Paramètre : index, row, $detail

• Détail :

  Il se déclenche lorsque vous cliquez sur l’icône de détail pour développer la vue détaillée. Les paramètres contiennent :

  • index : l’indice de la ligne développée.
  • row : l’enregistrement correspondant à la ligne développée.
  • $detail : l’élément DOM de la div de détail après l’élément tr actuel, vous pouvez utiliser des méthodes jQuery pour personnaliser les vues détaillées.

onLoadError

• Événement jQuery : load-error.bs.table

• Paramètre : status, jqXHR

• Détail :

  Il se déclenche lorsqu’une erreur se produit lors du chargement de données distantes. Les paramètres contiennent :

  • status : le code de statut de jqXHR.
  • jqXHR : objet jqXHR, qui est un sur-ensemble de l’objet XMLHTTPRequest. Pour plus d’informations, consultez le type jqXHR.

onLoadSuccess

• Événement jQuery : load-success.bs.table

• Paramètre : data

• Détail :

  Il se déclenche lorsque les données distantes sont chargées avec succès. Les paramètres contiennent :

  • data : les données distantes chargées dans le tableau. (Remarque : ces données ne peuvent pas être modifiées une fois chargées dans le tableau. Si vous avez besoin de traiter les données reçues avant de les utiliser dans le tableau, écrivez votre propre responseHandler à la place.)
  • status : le code de statut de jqXHR.
  • jqXHR : objet jqXHR, qui est un sur-ensemble de l’objet XMLHTTPRequest. Pour plus d’informations, consultez le type jqXHR.

onPageChange

• Événement jQuery : page-change.bs.table

• Paramètre : number, size

• Détail :

  Il se déclenche lors du changement du numéro de page ou de la taille de page. Les paramètres contiennent :

  • number : le numéro de page.
  • size : la taille de la page.

onPostBody

• Événement jQuery : post-body.bs.table

• Paramètre : data

• Détail :

  Il se déclenche après que le corps du tableau a été rendu et disponible dans le DOM. Les paramètres contiennent :

  • data : les données rendues.

onPostFooter

• Événement jQuery : post-footer.bs.table

• Paramètre : $tableFooter

• Détail :

  Il se déclenche après que le pied a été rendu et disponible dans le DOM. Les paramètres contiennent :

  • $tableFooter : l’élément DOM du pied.

onPostHeader

• Événement jQuery : post-header.bs.table

• Paramètre : undefined

• Détail :

  Il se déclenche après que l’en-tête du tableau a été rendu et disponible dans le DOM.

onPreBody

• Événement jQuery : pre-body.bs.table

• Paramètre : data

• Détail :

  Il se déclenche avant que le corps du tableau ne soit rendu. Les paramètres contiennent :

  • data : les données rendues.

onRefresh

• Événement jQuery : refresh.bs.table

• Paramètre : params

• Détail :

  Il se déclenche après le clic sur le bouton de rafraîchissement. Les paramètres contiennent :

  • params : les paramètres supplémentaires de requête au serveur.

onRefreshOptions

• Événement jQuery : refresh-options.bs.table

• Paramètre : options

• Détail :

  Il se déclenche après avoir rafraîchi les options, et avant de détruire et d’initialiser le tableau. Les paramètres contiennent :

  • options : l’objet d’options du tableau.

onResetView

• Événement jQuery : reset-view.bs.table

• Paramètre : undefined

• Détail :

  Il se déclenche lors de la réinitialisation de la vue du tableau.

onScrollBody

• Événement jQuery : scroll-body.bs.table

• Paramètre : $tableBody

• Détail :

  Il se déclenche lorsque le corps du tableau fait défiler.

onSearch

• Événement jQuery : search.bs.table

• Paramètre : text

• Détail :

  Il se déclenche lors de la recherche dans le tableau. Les paramètres contiennent :

  • text : le texte de la saisie de recherche.

onSort

• Événement jQuery : sort.bs.table

• Paramètre : name, order

• Détail :

  Il se déclenche lorsque l’utilisateur trie une colonne. Les paramètres contiennent :

  • name : le nom du champ de la colonne triée.
  • order : l’ordre de la colonne triée.

onToggle

• Événement jQuery : toggle.bs.table

• Paramètre : cardView

• Détail :

  Il se déclenche lors du basculement de la vue du tableau. Les paramètres contiennent :

  • cardView : l’état cardView du tableau.

onTogglePagination

• Événement jQuery : toggle-pagination.bs.table

• Paramètre : state

• Détail :

  Il se déclenche lorsque la pagination est basculée :

  • state : le nouvel état de pagination (true-> Pagination activée, false -> Pagination désactivée )

onUncheck

• Événement jQuery : uncheck.bs.table

• Paramètre : row, $element

• Détail :

  Il se déclenche lorsque l’utilisateur décoche une ligne. Les paramètres contiennent :

  • row : l’enregistrement correspondant à la ligne cliquée.
  • $element : l’élément DOM décoché.

onUncheckAll

• Événement jQuery : uncheck-all.bs.table

• Paramètre : rowsAfter, rowsBefore

• Détail :

  Il se déclenche lorsque l’utilisateur décoche toutes les lignes. Les paramètres contiennent :

  • rowsAfter : tableau d’enregistrements des lignes maintenant cochées.
  • rowsBefore : tableau d’enregistrements des lignes cochées auparavant.

onUncheckSome

• Événement jQuery : uncheck-some.bs.table

• Paramètre : rows

• Détail :

  Il se déclenche lorsque l’utilisateur décoche certaines lignes. Les paramètres contiennent :

  • rows : tableau d’enregistrements correspondant aux lignes précédemment cochées.

onVirtualScroll

• Événement jQuery : virtual-scroll.bs.table

• Paramètre : startIndex, endIndex

• Détail :

  Il se déclenche lorsque l’utilisateur fait défiler le défilement virtuel. Les paramètres contiennent :

  • startIndex : l’indice de la ligne de début du défilement virtuel.
  • endIndex : l’indice de la ligne de fin du défilement virtuel.