متدهای Bootstrap Table

API متدهای Bootstrap Table.

نحو فراخوانی متد: $('#table').bootstrapTable('method', parameter).

توجه: نام‌های متد زیر (مثل append، check، getData) نام‌های دقیق متدهایی هستند که باید در هنگام فراخوانی متدهای Bootstrap Table از طریق JavaScript استفاده شود.

مثال: $('#table').bootstrapTable('append', data)

append

• پارامتر: data

• جزئیات:

  data را به جدول اضافه می‌کند.

• مثال: Append

check

• پارامتر: index

• جزئیات:

  یک ردیف را بررسی می‌کند. index ردیف از 0 شروع می‌شود.

• مثال: Check/Uncheck

checkAll

• پارامتر: undefined

• جزئیات:

  تمام ردیف‌های صفحه جاری را بررسی می‌کند.

• مثال: Check/Uncheck All

checkBy

• پارامتر: params

• جزئیات:

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

  • field: نام فیلد استفاده شده برای یافتن رکوردهای مرتبط.
  • values: آرایه مقادیر برای ردیف‌هایی که باید بررسی شوند.
  • onlyCurrentPage (default false): اگر true باشد، فقط مجموعه داده‌های قابل مشاهده بررسی خواهد شد. اگر صفحه‌بندی استفاده شود، صفحات دیگر نادیده گرفته خواهد شد.

• مثال: Check/Uncheck By

checkInvert

• پارامتر: undefined

• جزئیات:

  بررسی ردیف‌های صفحه جاری را معکوس می‌کند. رویدادهای onCheckSome و onUncheckSome را تحریک می‌کند.

• مثال: Check Invert

collapseAllRows

• پارامتر: undefined

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، تمام ردیف‌ها را جمع می‌کند.

• مثال: Expand/Collapse All Rows

collapseRow

• پارامتر: index

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، ردیفی با index که توسط پارامتر پاس شده است را جمع می‌کند.

• مثال: Expand/Collapse Row

collapseRowByUniqueId

• پارامتر: uniqueId

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، ردیفی با uniqueId که توسط پارامتر پاس شده است را جمع می‌کند.

• مثال: Expand/Collapse Row by uniqueId

destroy

• پارامتر: undefined

• جزئیات:

  Bootstrap Table را از بین می‌برد.

• مثال: Destroy

expandAllRows

• پارامتر: undefined

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، تمام ردیف‌ها را گسترش می‌دهد.

• مثال: Expand/Collapse All Rows

expandRow

• پارامتر: index

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، ردیفی که دارای index پاس شده توسط پارامتر است را گسترش می‌دهد.

• مثال: Expand/Collapse Row

expandRowByUniqueId

• پارامتر: uniqueId

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، ردیفی با uniqueId پاس شده توسط پارامتر را گسترش می‌دهد.

• مثال: Expand/Collapse Row by uniqueId

filterBy

• پارامتر:

  • filter - شیء فیلتر پیش‌فرض: {}
  • options - شیء گزینه‌ها پیش‌فرض:

    {
        'filterAlgorithm': 'and'
    }

• جزئیات:

  (فقط می‌تواند در سمت کلاینت استفاده شود) داده‌ها را در جدول فیلتر می‌کند. راه‌های مختلفی برای فیلتر وجود دارد:

  • گزینه‌ها را خالی رها کنید تا فیلتر and استفاده شود.
  • filterAlgorithm (در پارامتر ببینید) را روی or تنظیم کنید تا فیلتر or استفاده شود.
  • تابعی را به filterAlgorithm (در پارامتر ببینید) پاس دهید تا فیلتر custom استفاده شود.

  الگوریتم فیلتر

  • And
    • فیلتر {age: 10} برای نمایش داده‌هایی که فقط سن آن‌ها برابر با 10 است. همچنین می‌توانید با آرایه‌ای از مقادیر فیلتر کنید، مانند: {age: 10, hairColor: ['blue', 'red', 'green']} برای یافتن داده‌هایی که سن برابر با 10 است و رنگ مو آن‌ها آبی، قرمز یا سبز است.
  • Or
    • فیلتر {age: 10, name: "santa"} برای نمایش تمام داده‌هایی که سن 10 دارند یا نام آن‌ها برابر با santa است.
  • Custom
    • با الگوریتم سفارشی خود فیلتر کنید
    • پارامترهای تابع:
      • Row
      • Filters
    • برای حفظ ردیف true بازگردانید و برای فیلتر کردن ردیف false بازگردانید.

• مثال: Filter By

getData

• پارامتر: params

• جزئیات:

  داده‌های بارگذاری شده جدول را در لحظه فراخوانی این متد دریافت می‌کند

  • useCurrentPage: اگر روی true تنظیم شود، متد فقط داده‌های صفحه جاری را بازگرداند.
  • includeHiddenRows: اگر روی true تنظیم شود، متد ردیف‌های مخفی را شامل می‌شود.
  • unfiltered: اگر روی true تنظیم شود، متد تمام داده‌ها را شامل می‌شود (فیلتر نشده).
  • formatted: مقدار فرمت شده را از formatter تعریف شده دریافت می‌کند.

• مثال: Get Data

getFooterData

• پارامتر: undefined

• جزئیات:

  داده‌های بارگذاری شده فوتر را در لحظه فراخوانی این متد دریافت می‌کند

• مثال: Get Footer Data

getHiddenColumns

• پارامتر: undefined

• جزئیات:

  ستون‌های مخفی را دریافت می‌کند.

• مثال: Get Visible/Hidden Columns

getHiddenRows

• پارامتر: show

• جزئیات:

  تمام ردیف‌های مخفی را دریافت می‌کند، و اگر پارامتر show را true پاس دهید، ردیف‌ها دوباره نمایش داده می‌شوند. در غیر این صورت، متد فقط ردیف‌های مخفی را بازگرداند.

• مثال: Get Hidden Rows

getOptions

• پارامتر: undefined

• جزئیات:

  شیء گزینه‌ها را بازگرداند.

• مثال: Get Options

getRowByUniqueId

• پارامتر: id

• جزئیات:

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

• مثال: Get Row By Unique Id

getScrollPosition

• پارامتر: undefined

• جزئیات:

  موقعیت اسکرول کنونی را دریافت می‌کند. واحد 'px' است.

• مثال: Get Scroll Position

getSelections

• پارامتر: undefined

• جزئیات:

  ردیف‌های انتخاب شده را بازگرداند. وقتی هیچ رکوردی انتخاب نشده باشد، یک آرایه خالی بازگردانده می‌شود. ردیف‌های انتخاب شده در حین برخی عملیات، مانند جستجو یا تغییر صفحه، غیرانتخاب می‌شوند. اگر می‌خواهید انتخاب‌ها را حفظ کنید، لطفاً از maintainMetaData استفاده کنید.

• مثال: Get Selections

getVisibleColumns

• پارامتر: -

• جزئیات:

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

• مثال: Get Visible/Hidden Columns

hideAllColumns

• پارامتر: undefined

• جزئیات:

  تمام ستون‌ها را مخفی می‌کند.

• مثال: Show/Hide All Columns

hideColumn

• پارامتر: field

• جزئیات:

  ستون field مشخص شده را مخفی می‌کند. پارامتر می‌تواند یک رشته یا آرایه‌ای از فیلدها باشد.

• مثال: Show/Hide Column

hideLoading

• پارامتر: undefined

• جزئیات:

  وضعیت بارگذاری را مخفی می‌کند.

• مثال: Show/Hide Loading

hideRow

• پارامتر: params

• جزئیات:

  ردیف مشخص شده را مخفی می‌کند. params باید حداقل یکی از ویژگی‌های زیر را شامل باشد:

  • index: شاخص ردیف.
  • uniqueId: مقدار uniqueId برای آن ردیف.

• مثال: Show/Hide Row

insertRow

• پارامتر: params

• جزئیات:

  یک ردیف جدید وارد می‌کند. params شامل ویژگی‌های زیر است:

  • index: شاخص ردیف برای وارد کردن.
  • row: داده‌های ردیف.

• مثال: Insert Row

load

• پارامتر: data

• جزئیات:

  data را به جدول بارگذاری می‌کند. ردیف‌های قدیمی حذف می‌شوند.

• مثال: Load

mergeCells

• پارامتر: params

• جزئیات:

  برخی سلول‌ها را به یک سلول می‌چسباند. params شامل ویژگی‌های زیر است:

  • index: شاخص ردیف.
  • field: نام فیلد.
  • rowspan: تعداد rowspan برای ادغام.
  • colspan: تعداد colspan برای ادغام.

• مثال: Merge Cells

nextPage

• پارامتر: undefined

• جزئیات:

  به صفحه بعد می‌رود.

• مثال: Select/Prev/Next Page

prepend

• پارامتر: data

• جزئیات:

  data را در ابتدای جدول اضافه می‌کند.

• مثال: Prepend

prevPage

• پارامتر: undefined

• جزئیات:

  به صفحه قبل می‌رود.

• مثال: Select/Prev/Next Page

refresh

• پارامتر: params

• جزئیات:

  داده‌های سرور راه دور را رفرش/بارگذاری مجدد می‌کند. پیکربندی‌های پارامتر زیر را پشتیبانی می‌کند:

  • silent (پیش‌فرض: false): برای رفرش خاموش داده‌ها بدون نمایش وضعیت بارگذاری، روی true تنظیم کنید.
  • url: اختیاری، به صورت موقت URL درخواست فعلی را جایگزین می‌کند.
  • pageNumber: اختیاری، شماره صفحه‌ای را که باید به آن بروید مشخص کنید.
  • pageSize: اختیاری، تعداد رکوردهای نمایش داده شده در هر صفحه را مشخص کنید.
  • query: اختیاری، پارامترهای کوئری اضافی را برای این درخواست اضافه کنید.

  مثال استفاده:

  // رفرش خاموش
  $('#table').bootstrapTable('refresh', {silent: true})
  
  // تغییر URL و پارامترهای صفحه‌بندی
  $('#table').bootstrapTable('refresh', {
    url: '/new/api/endpoint',
    pageNumber: 2,
    pageSize: 20
  })
  
  // اضافه کردن پارامترهای کوئری
  $('#table').bootstrapTable('refresh', {
    query: {status: 'active', category: 'electronics'}
  })

• مثال: Refresh

refreshOptions

• پارامتر: options

• جزئیات:

  گزینه‌های جدول را رفرش می‌کند.

• مثال: Refresh Options

remove

• پارامتر: params

• جزئیات:

  داده‌ها را از جدول حذف می‌کند. params شامل ویژگی‌های زیر است:

  • field: نام فیلد استفاده شده برای مطابقت ردیف‌هایی که باید حذف شوند. می‌توانید از فیلد ویژه $index برای حذف ردیف‌ها بر اساس شاخص ردیف استفاده کنید.
  • values: آرایه‌ای از مقادیر فیلد برای ردیف‌هایی که باید حذف شوند. اگر از فیلد ویژه $index استفاده می‌کنید، می‌توانید آرایه‌ای از شاخص‌های ردیف پاس دهید.

  مثال‌های استفاده:

  // حذف بر اساس فیلد id
  $('#table').bootstrapTable('remove', {
    field: 'id',
    values: [1, 2, 3]
  })
  
  // حذف بر اساس شاخص ردیف (از 0 شروع می‌شود)
  $('#table').bootstrapTable('remove', {
    field: '$index',
    values: [0, 2, 4]
  })
  
  // حذف بر اساس فیلد دیگری
  $('#table').bootstrapTable('remove', {
    field: 'name',
    values: ['John', 'Jane']
  })

• مثال: Remove

removeAll

• پارامتر: undefined

• جزئیات:

  تمام داده‌ها را از جدول حذف می‌کند.

• مثال: Remove All

removeByUniqueId

• پارامتر: id

• جزئیات:

  داده‌ها را از جدول حذف می‌کند، ردیفی که شامل id پاس شده توسط پارامتر است.

• مثال: Remove By Unique Id

resetSearch

• پارامتر: text

• جزئیات:

  متن جستجو را تنظیم می‌کند.

• مثال: Reset Search

resetView

• پارامتر: params

• جزئیات:

  نمای Bootstrap Table را ریست می‌کند. برای مثال، ارتفاع جدول را ریست می‌کند، params شامل موارد زیر است:

  • height: ارتفاع جدول.

• مثال: Reset View

scrollTo

• پارامتر: value|object

• جزئیات:

  • value
    • به موقعیت عدد value اسکرول می‌کند، واحد 'px' است، تنظیم 'bottom' به معنی اسکرول به پایین است.
  • object
    • به واحد (px یا rows (شاخص از 0 شروع می‌شود)) اسکرول می‌کند پیش‌فرض: {unit: 'px', value: 0}

• مثال: Scroll To

selectPage

• پارامتر: page

• جزئیات:

  به page مشخص شده می‌رود.

• مثال: Select/Prev/Next Page

showAllColumns

• پارامتر: undefined

• جزئیات:

  تمام ستون‌ها را نمایش می‌دهد.

• مثال: Show/Hide All Columns

showColumn

• پارامتر: field

• جزئیات:

  ستون field مشخص شده را نمایش می‌دهد. پارامتر می‌تواند یک رشته یا آرایه‌ای از فیلدها باشد.

• مثال: Show/Hide Column

showLoading

• پارامتر: undefined

• جزئیات:

  وضعیت بارگذاری را نمایش می‌دهد.

• مثال: Show/Hide Loading

showRow

• پارامتر: params

• جزئیات:

  ردیف مشخص شده را نمایش می‌دهد. params باید حداقل یکی از ویژگی‌های زیر را شامل باشد:

  • index: شاخص ردیف.
  • uniqueId: مقدار uniqueId برای آن ردیف.

• مثال: Show/Hide Row

sortBy

• پارامتر: params

• جزئیات:

  جدول را بر اساس فیلد مشخص شده مرتب می‌کند. params باید حداقل یکی از ویژگی‌های زیر را شامل باشد:

  • field: نام فیلد.
  • sortOrder: مرتبه مرتب سازی، فقط می‌تواند ‘asc’ یا ‘desc’ باشد.

• مثال: Sort By

sortReset

• پارامتر: undefined

• جزئیات:

  وضعیت مرتب سازی جدول را ریست می‌کند، بدون در نظر گرفتن اینکه آیا توسط کاربر یا به صورت برنامه‌ای ایجاد شده است.

• مثال: Sort reset

toggleDetailView

• پارامتر: index

• جزئیات:

  اگر گزینه نمای جزئیات روی true تنظیم شده باشد، ردیفی که دارای index پاس شده توسط پارامتر است را تغییر می‌دهد.

• مثال: Toggle Detail View

toggleFullscreen

• پارامتر: undefined

• جزئیات:

  وضعیت تمام صفحه را تغییر می‌دهد.

• مثال: Toggle Fullscreen

togglePagination

• پارامتر: undefined

• جزئیات:

  وضعیت صفحه‌بندی را تغییر می‌دهد.

• مثال: Toggle Pagination

toggleView

• پارامتر: undefined

• جزئیات:

  نمای کارت/جدول را تغییر می‌دهد.

• مثال: Toggle View

uncheck

• پارامتر: index

• جزئیات:

  یک ردیف را غیربررسی می‌کند. index ردیف از 0 شروع می‌شود.

• مثال: Check/Uncheck

uncheckAll

• پارامتر: undefined

• جزئیات:

  تمام ردیف‌های صفحه جاری را غیربررسی می‌کند.

• مثال: Check/Uncheck All

uncheckBy

• پارامتر: params

• جزئیات:

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

  • field: نام فیلد استفاده شده برای یافتن رکوردهای مرتبط.
  • values: آرایه مقادیر برای ردیف‌هایی که باید غیربررسی شوند.
  • onlyCurrentPage (default false): اگر true باشد، فقط مجموعه داده‌های قابل مشاهده غیربررسی خواهد شد. اگر صفحه‌بندی استفاده شود، صفحات دیگر نادیده گرفته خواهد شد.

• مثال: Check/Uncheck By

updateByUniqueId

• پارامتر: params

• جزئیات:

  ردیف(های) مشخص شده را به‌روزرسانی می‌کند. هر param شامل ویژگی‌های زیر است:

  • id: یک شناسه ردیف که باید فیلد uniqueId اختصاص داده شده به جدول باشد.
  • row: داده‌های جدید ردیف.
  • replace (اختیاری): برای جایگزینی ردیف به جای گسترش آن، روی true تنظیم کنید.

• مثال: Update By Unique Id

updateCell

• پارامتر: params

• جزئیات:

  یک سلول را به‌روزرسانی می‌کند. params شامل ویژگی‌های زیر است:

  • index: شاخص ردیف.
  • field: نام فیلد.
  • value: مقدار جدید فیلد.

  برای غیرفعال کردن مجدد راه‌اندازی جدول، می‌توانید {reinit: false} تنظیم کنید.

• مثال: Update Cell

updateCellByUniqueId

• پارامتر: params

• جزئیات:

  سلول(های) مشخص شده را به‌روزرسانی می‌کند. هر param شامل ویژگی‌های زیر است:

  • id: شناسه ردیف که باید فیلد uniqueId اختصاص داده شده به جدول باشد.
  • field: نام فیلد سلولی که باید به‌روزرسانی شود.
  • value: مقدار جدید سلول.

  برای غیرفعال کردن مجدد راه‌اندازی جدول، می‌توانید {reinit: false} تنظیم کنید.

• مثال: Update Cell By Unique Id

updateColumnTitle

• پارامتر: params

• جزئیات:

  عنوان فیلد ستون را به‌روزرسانی می‌کند. params شامل ویژگی‌های زیر است:

  • field: نام فیلد.
  • title: عنوان فیلد.

• مثال: Update Column Title

updateFormatText

• پارامتر: formatName, text

• جزئیات:

  متن فرمت بومی‌سازی‌ها را به‌روزرسانی می‌کند.

• مثال: Update Format Text

updateRow

• پارامتر: params

• جزئیات:

  ردیف(های) مشخص شده را به‌روزرسانی می‌کند. هر param شامل ویژگی‌های زیر است:

  • index: شاخص ردیف که باید به‌روزرسانی شود.
  • row: داده‌های جدید ردیف.
  • replace (اختیاری): برای جایگزینی ردیف به جای گسترش آن، روی true تنظیم کنید.

• مثال: Update Row