رویدادهای Bootstrap Table

API رویدادهای Bootstrap Table.

رویدادها می‌توانند به دو روش پیوند داده شوند:

• از طریق شیء گزینه
• از طریق обработчик رویداد jquery

پیوند از طریق شیء گزینه‌ها:

// در اینجا، می‌توانید انتظار داشته باشید که آخرین پارامتر شیء bootstrap-table باشد

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

پیوند از طریق обработчик رویداد jquery:

// در اینجا، می‌توانید انتظار داشته باشید که در متغیر 'e' خاصیت sender وجود داشته باشد، که شیء bootstrap-table است

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

تلمیح: اگر از обработчик رویداد jquery استفاده می‌کنید، اطمینان حاصل کنید که شنونده رویداد قبل از اجرای رویداد پیوند داده شده باشد!

توجه: نام‌های رویدادهای زیر (به عنوان مثال، onCheck، onClickRow، onLoadSuccess) نام‌های دقیق رویدادهای هستند که باید هنگام پیوند دادن رویدادها از طریق JavaScript استفاده شوند.

onAll

• رویداد jQuery: all.bs.table

• پارامتر: name, args

• جزئیات:

  وقتی هر رویدادی تحریک می‌شود، فعال می‌شود. پارامترها شامل موارد زیر است:

  • name: نام رویداد,
  • args: داده‌های رویداد.

onCheck

• رویداد jQuery: check.bs.table

• پارامتر: row, $element

• جزئیات:

  وقتی کاربر یک ردیف را بررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر DOM بررسی شده.

onCheckAll

• رویداد jQuery: check-all.bs.table

• پارامتر: rowsAfter, rowsBefore

• جزئیات:

  وقتی کاربر تمام ردیف‌ها را بررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • rowsAfter: آرایه رکوردهای ردیف‌های حالا بررسی شده.
  • rowsBefore: آرایه رکوردهای ردیف‌های بررسی شده قبل.

onCheckSome

• رویداد jQuery: check-some.bs.table

• پارامتر: rows

• جزئیات:

  وقتی کاربر برخی ردیف‌ها را بررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • rows: آرایه رکوردهای مربوط به ردیف‌های جدید بررسی شده.

onClickCell

• رویداد jQuery: click-cell.bs.table

• پارامتر: field, value, row, $element

• جزئیات:

  وقتی کاربر روی یک سلول کلیک می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • field: نام فیلد مربوط به سلول کلیک شده.
  • value: مقدار داده مربوط به سلول کلیک شده.
  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر td.

onClickRow

• رویداد jQuery: click-row.bs.table

• پارامتر: row, $element, field

• جزئیات:

  وقتی کاربر روی یک ردیف کلیک می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر tr.
  • field: نام فیلد مربوط به سلول کلیک شده.

onCollapseRow

• رویداد jQuery: collapse-row.bs.table

• پارامتر: index, row, detailView

• جزئیات:

  وقتی روی آیکون جزئیات کلیک می‌کنید تا نمای جزئیات را جمع کنید، فعال می‌شود. پارامترها شامل موارد زیر است:

  • index: شاخص ردیف جمع شده.
  • row: رکورد مربوط به ردیف جمع شده.
  • detailView: نمای جزئیات جمع شده.

onColumnSwitch

• رویداد jQuery: column-switch.bs.table

• پارامتر: field, checked

• جزئیات:

  وقتی ستون قابل‌مشاهده را تغییر می‌دهید (showColumns)، فعال می‌شود. پارامترها شامل موارد زیر است:

  • field: نام فیلد مربوط به ستون سوئیچ شده.
  • checked: وضعیت بررسی شده ستون.

onColumnSwitchAll

• رویداد jQuery: column-switch-all.bs.table

• پارامتر: checked

• جزئیات:

  وقتی تمام ستون‌ها را تغییر می‌دهید، فعال می‌شود. پارامترها شامل موارد زیر است:

  • checked: وضعیت بررسی شده ستون.

onDblClickCell

• رویداد jQuery: dbl-click-cell.bs.table

• پارامتر: field, value, row, $element

• جزئیات:

  وقتی کاربر روی یک سلول دو بار کلیک می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • field: نام فیلد مربوط به سلول کلیک شده.
  • value: مقدار داده مربوط به سلول کلیک شده.
  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر td.

onDblClickRow

• رویداد jQuery: dbl-click-row.bs.table

• پارامتر: row, $element, field

• جزئیات:

  وقتی کاربر روی یک ردیف دو بار کلیک می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر tr.
  • field: نام فیلد مربوط به سلول کلیک شده.

onExpandRow

• رویداد jQuery: expand-row.bs.table

• پارامتر: index, row, $detail

• جزئیات:

  وقتی روی آیکون جزئیات کلیک می‌کنید تا نمای جزئیات را گسترش دهید، فعال می‌شود. پارامترها شامل موارد زیر است:

  • index: شاخص ردیف گسترش شده.
  • row: رکورد مربوط به ردیف گسترش شده.
  • $detail: عنصر DOM div جزئیات بعد از عنصر tr کنونی، می‌توانید از متدهای jQuery برای سفارشی‌سازی نمای‌های جزئیات استفاده کنید.

onLoadError

• رویداد jQuery: load-error.bs.table

• پارامتر: status, jqXHR

• جزئیات:

  وقتی برخی خطاها در بارگذاری داده‌های راه دور رخ می‌دهد، فعال می‌شود. پارامترها شامل موارد زیر است:

  • status: کد وضعیت jqXHR.
  • jqXHR: شیء jqXHR، که یک مجموعه فرا از شیء XMLHTTPRequest است. برای اطلاعات بیشتر، به jqXHR Type مراجعه کنید.

onLoadSuccess

• رویداد jQuery: load-success.bs.table

• پارامتر: data

• جزئیات:

  وقتی داده‌های راه دور با موفقیت بارگذاری می‌شوند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • data: داده‌های راه دور بارگذاری شده در جدول. (توجه: این داده نمی‌تواند پس از بارگذاری در جدول تغییر کند. اگر نیاز دارید داده‌های دریافتی را قبل از استفاده در جدول پردازش کنید، вместо آن responseHandler سفارشی خود را بنویسید.)
  • status: کد وضعیت jqXHR.
  • jqXHR: شیء jqXHR، که یک مجموعه فرا از شیء XMLHTTPRequest است. برای اطلاعات بیشتر، به jqXHR Type مراجعه کنید.

onPageChange

• رویداد jQuery: page-change.bs.table

• پارامتر: number, size

• جزئیات:

  وقتی شماره صفحه یا اندازه صفحه تغییر می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • number: شماره صفحه.
  • size: اندازه صفحه.

onPostBody

• رویداد jQuery: post-body.bs.table

• پارامتر: data

• جزئیات:

  پس از رندر بدنه جدول و در دسترس بودن آن در DOM، فعال می‌شود. پارامترها شامل موارد زیر است:

  • data: داده‌های رندر شده.

onPostFooter

• رویداد jQuery: post-footer.bs.table

• پارامتر: $tableFooter

• جزئیات:

  پس از رندر فوتر و در دسترس بودن آن در DOM، فعال می‌شود. پارامترها شامل موارد زیر است:

  • $tableFooter: عنصر DOM فوتر.

onPostHeader

• رویداد jQuery: post-header.bs.table

• پارامتر: undefined

• جزئیات:

  پس از رندر سرستون و در دسترس بودن آن در DOM، فعال می‌شود.

onPreBody

• رویداد jQuery: pre-body.bs.table

• پارامتر: data

• جزئیات:

  قبل از رندر بدنه جدول، فعال می‌شود. پارامترها شامل موارد زیر است:

  • data: داده‌های رندر شده.

onRefresh

• رویداد jQuery: refresh.bs.table

• پارامتر: params

• جزئیات:

  پس از کلیک روی دکمه رفرش، فعال می‌شود. پارامترها شامل موارد زیر است:

  • params: پارامترهای اضافی درخواست شده به سرور.

onRefreshOptions

• رویداد jQuery: refresh-options.bs.table

• پارامتر: options

• جزئیات:

  پس از رفرش گزینه‌ها و قبل از 파괴 و راه‌اندازی جدول، فعال می‌شود. پارامترها شامل موارد زیر است:

  • options: شیء گزینه‌های جدول.

onResetView

• رویداد jQuery: reset-view.bs.table

• پارامتر: undefined

• جزئیات:

  وقتی نمای جدول ریست می‌شود، فعال می‌شود.

onScrollBody

• رویداد jQuery: scroll-body.bs.table

• پارامتر: $tableBody

• جزئیات:

  وقتی بدنه جدول اسکرول می‌شود، فعال می‌شود.

onSearch

• رویداد jQuery: search.bs.table

• پارامتر: text

• جزئیات:

  وقتی در جدول جستجو می‌کنید، فعال می‌شود. پارامترها شامل موارد زیر است:

  • text: متن ورودی جستجو.

onSort

• رویداد jQuery: sort.bs.table

• پارامتر: name, order

• جزئیات:

  وقتی کاربر یک ستون را مرتب می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • name: نام فیلد ستون مرتب شده.
  • order: مرتبه ستون مرتب شده.

onToggle

• رویداد jQuery: toggle.bs.table

• پارامتر: cardView

• جزئیات:

  وقتی نمای جدول را تغییر می‌دهید، فعال می‌شود. پارامترها شامل موارد زیر است:

  • cardView: وضعیت cardView جدول.

onTogglePagination

• رویداد jQuery: toggle-pagination.bs.table

• پارامتر: state

• جزئیات:

  وقتی صفحه‌بندی تغییر می‌کند، فعال می‌شود:

  • state: وضعیت جدید صفحه‌بندی (true-> صفحه‌بندی فعال است، false -> صفحه‌بندی غیرفعال است )

onUncheck

• رویداد jQuery: uncheck.bs.table

• پارامتر: row, $element

• جزئیات:

  وقتی کاربر یک ردیف را غیربررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • row: رکورد مربوط به ردیف کلیک شده.
  • $element: عنصر DOM غیربررسی شده.

onUncheckAll

• رویداد jQuery: uncheck-all.bs.table

• پارامتر: rowsAfter, rowsBefore

• جزئیات:

  وقتی کاربر تمام ردیف‌ها را غیربررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • rowsAfter: آرایه رکوردهای ردیف‌های حالا غیربررسی شده.
  • rowsBefore: آرایه رکوردهای ردیف‌های بررسی شده قبل.

onUncheckSome

• رویداد jQuery: uncheck-some.bs.table

• پارامتر: rows

• جزئیات:

  وقتی کاربر برخی ردیف‌ها را غیربررسی می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • rows: آرایه رکوردهای مربوط به ردیف‌های جدید غیربررسی شده.

onVirtualScroll

• رویداد jQuery: virtual-scroll.bs.table

• پارامتر: startIndex, endIndex

• جزئیات:

  وقتی کاربر اسکرول مجازی را اسکرول می‌کند، فعال می‌شود. پارامترها شامل موارد زیر است:

  • startIndex: شاخص شروع ردیف اسکرول مجازی.
  • endIndex: شاخص پایان ردیف اسکرول مجازی.