githab
/
bootstrap-table


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493
							<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="The Methods API of Bootstrap Table.">
<meta name="author" content="Zhixin Wen, and Bootstrap Table contributors">
<meta name="generator" content="Jekyll v3.8.5">
<meta name="keywords" content="bootstrap,table,pagination,checkbox,radio,datatables,css,css-framework,semantic,semantic-ui,bulma,material,material-design,materialize,foundation">

<meta name="docsearch:language" content="en">

<title>Methods · Bootstrap Table</title>

<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous"><!-- Documentation extras -->

<link href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" rel="stylesheet">


<link href="/assets/css/docs.min.css" rel="stylesheet">
<link href="/assets/css/style.css?m=7" rel="stylesheet">

<!-- Favicons -->
<link rel="icon" href="/favicon.png">


<script type="text/javascript">
  if (window !== top) // 判断当前的 window 对象是否是 top 对象
    top.location.href = window.location.href // 如果不是，将 top 对象的网址自动导向被嵌入网页的网址
</script>

  </head>
  <body>
    <a class="skippy sr-only sr-only-focusable" href="#content">
  <span class="skippy-text">Skip to main content</span>
</a>


    <header class="navbar navbar-expand navbar-dark flex-column flex-md-row bd-navbar">
  <a class="navbar-brand mr-0 mr-md-2" href="/" aria-label="Bootstrap">
    <img src="/favicon.png" width="36" height="36">
  </a>

  <div class="navbar-nav-scroll">
    <ul class="navbar-nav bd-navbar-nav flex-row">
      <li class="nav-item">
        <a class="nav-link "
          href="/">Home</a>
      </li>
      <li class="nav-item">
        <a class="nav-link active"
          href="/docs/getting-started/introduction/">
          Documentation
        </a>
      </li>
      <li class="nav-item ">
        <a class="nav-link" href="/themes">
          Themes
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link "
          href="https://examples.bootstrap-table.com">
          Examples
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
          href="https://live.bootstrap-table.com"
          target="_blank">
          Online Editor
        </a>
      </li>
      <li class="nav-item ">
        <a class="nav-link" href="/news">
          News
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
          href="https://blog.bootstrap-table.com"
          target="_blank">
          Blog
        </a>
      </li>
    </ul>
  </div>

  <ul class="navbar-nav flex-row ml-md-auto d-none d-md-flex">
    <li class="nav-item dropdown">
      <a class="nav-item nav-link dropdown-toggle mr-md-2" href="#" id="bd-versions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
        v1.17.1
      </a>
      <div class="dropdown-menu dropdown-menu-md-right" aria-labelledby="bd-versions">
        <a class="dropdown-item active" href="/">Latest (1.17.1)</a>
        <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.16.0/" target="_blank">v1.16.0</a>
        <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.15.5/" target="_blank">v1.15.5</a>
      </div>
    </li>
    <li class="nav-item">
      <a class="nav-link p-2" href="https://github.com/wenzhixin/bootstrap-table" target="_blank" rel="noopener" aria-label="GitHub"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 499.36" focusable="false" role="img"><path d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z" fill="currentColor" fill-rule="evenodd"/></svg>
</a>
    </li>
    <li class="nav-item">
      <a class="nav-link p-2" href="https://twitter.com/wenzhixin2010" target="_blank" rel="noopener" aria-label="Twitter"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 416.32" focusable="false" role="img"><path d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92" fill="currentColor"/></svg>
</a>
    </li>
    <li class="nav-item">
      <a class="nav-link p-2" href="https://opencollective.com/bootstrap-table" target="_blank" rel="noopener" aria-label="Open Collective"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 40 41" focusable="false" role="img" fill="currentColor" fill-rule="evenodd"><title>Open Collective</title><path d="M32.8 21c0 2.4-.8 4.9-2 6.9l5.1 5.1c2.5-3.4 4.1-7.6 4.1-12 0-4.6-1.6-8.8-4-12.2L30.7 14c1.2 2 2 4.3 2 7z" fill-opacity=".4"/><path d="M20 33.7a12.8 12.8 0 0 1 0-25.6c2.6 0 5 .7 7 2.1L32 5a20 20 0 1 0 .1 31.9l-5-5.2a13 13 0 0 1-7 2z"/></svg>
</a>
    </li>
  </ul>

  <a class="btn btn-bd-download d-none d-lg-inline-block mb-3 mb-md-0 ml-md-3"
    href="/docs/getting-started/download/">Download</a>
</header>


    <div class="container-fluid">
      <div class="row flex-xl-nowrap">
        <div class="col-12 col-md-3 col-xl-2 bd-sidebar">
          <form class="bd-search d-flex align-items-center">
  <input type="search" class="form-control"
    id="search-input" placeholder="Search..."
    aria-label="Search for..." autocomplete="off">
  <button class="btn btn-link bd-search-docs-toggle d-md-none p-0 ml-3"
    type="button" data-toggle="collapse" data-target="#bd-docs-nav"
    aria-controls="bd-docs-nav" aria-expanded="false"
    aria-label="Toggle docs navigation"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 30 30" width="30" height="30" focusable="false" role="img"><title>Menu</title><path stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-miterlimit="10" d="M4 7h22M4 15h22M4 23h22"/></svg>
</button>
</form>

<nav class="collapse bd-links" id="bd-docs-nav"><div class="bd-toc-item">
    <a class="bd-toc-link" href="/docs/getting-started/introduction/">
      Getting started
    </a>

    <ul class="nav bd-sidenav"><li>
          <a href="/docs/getting-started/introduction/">
            Introduction
          </a>
        </li><li>
          <a href="/docs/getting-started/download/">
            Download
          </a>
        </li><li>
          <a href="/docs/getting-started/contents/">
            Contents
          </a>
        </li><li>
          <a href="/docs/getting-started/usage/">
            Usage
          </a>
        </li><li>
          <a href="/docs/getting-started/browsers-devices/">
            Browsers & devices
          </a>
        </li><li>
          <a href="/docs/getting-started/build-tools/">
            Build tools
          </a>
        </li></ul>
  </div><div class="bd-toc-item active">
    <a class="bd-toc-link" href="/docs/api/table-options/">
      API
    </a>

    <ul class="nav bd-sidenav"><li>
          <a href="/docs/api/table-options/">
            Table Options
          </a>
        </li><li>
          <a href="/docs/api/column-options/">
            Column Options
          </a>
        </li><li>
          <a href="/docs/api/events/">
            Events
          </a>
        </li><li class="active bd-sidenav-active">
          <a href="/docs/api/methods/">
            Methods
          </a>
        </li><li>
          <a href="/docs/api/localizations/">
            Localizations
          </a>
        </li></ul>
  </div><div class="bd-toc-item">
    <a class="bd-toc-link" href="/docs/extensions/addrbar/">
      Extensions
    </a>

    <ul class="nav bd-sidenav"><li>
          <a href="/docs/extensions/addrbar/">
            Addrbar
          </a>
        </li><li>
          <a href="/docs/extensions/auto-refresh/">
            Auto Refresh
          </a>
        </li><li>
          <a href="/docs/extensions/cookie/">
            Cookie
          </a>
        </li><li>
          <a href="/docs/extensions/copy-rows/">
            Copy Rows
          </a>
        </li><li>
          <a href="/docs/extensions/defer-url/">
            Defer URL
          </a>
        </li><li>
          <a href="/docs/extensions/editable/">
            Editable
          </a>
        </li><li>
          <a href="/docs/extensions/export/">
            Export
          </a>
        </li><li>
          <a href="/docs/extensions/filter-control/">
            Filter Control
          </a>
        </li><li>
          <a href="/docs/extensions/fixed-columns/">
            Fixed Columns
          </a>
        </li><li>
          <a href="/docs/extensions/group-by-v2/">
            Group By v2
          </a>
        </li><li>
          <a href="/docs/extensions/i18n-enhance/">
            i18n Enhance
          </a>
        </li><li>
          <a href="/docs/extensions/key-events/">
            Key Events
          </a>
        </li><li>
          <a href="/docs/extensions/mobile/">
            Mobile
          </a>
        </li><li>
          <a href="/docs/extensions/multiple-sort/">
            Multiple Sort
          </a>
        </li><li>
          <a href="/docs/extensions/page-jump-to/">
            Page Jump To
          </a>
        </li><li>
          <a href="/docs/extensions/pipeline/">
            Pipeline
          </a>
        </li><li>
          <a href="/docs/extensions/print/">
            Print
          </a>
        </li><li>
          <a href="/docs/extensions/reorder-columns/">
            Reorder Columns
          </a>
        </li><li>
          <a href="/docs/extensions/reorder-rows/">
            Reorder Rows
          </a>
        </li><li>
          <a href="/docs/extensions/resizable/">
            Resizable
          </a>
        </li><li>
          <a href="/docs/extensions/sticky-header/">
            Sticky Header
          </a>
        </li><li>
          <a href="/docs/extensions/toolbar/">
            Toolbar
          </a>
        </li><li>
          <a href="/docs/extensions/treegrid/">
            Treegrid
          </a>
        </li></ul>
  </div><div class="bd-toc-item">
    <a class="bd-toc-link" href="/docs/vuejs/introduction/">
      VueJS
    </a>

    <ul class="nav bd-sidenav"><li>
          <a href="/docs/vuejs/introduction/">
            Introduction
          </a>
        </li><li>
          <a href="/docs/vuejs/browser/">
            Browser
          </a>
        </li><li>
          <a href="/docs/vuejs/webpack/">
            Webpack
          </a>
        </li><li>
          <a href="/docs/vuejs/component/">
            Component
          </a>
        </li></ul>
  </div><div class="bd-toc-item">
    <a class="bd-toc-link" href="/docs/faq/">
      FAQ
    </a>

    <ul class="nav bd-sidenav"></ul>
  </div><div class="bd-toc-item">
    <a class="bd-toc-link" href="/docs/about/overview/">
      About
    </a>

    <ul class="nav bd-sidenav"><li>
          <a href="/docs/about/overview/">
            Overview
          </a>
        </li><li>
          <a href="/docs/about/team/">
            Team
          </a>
        </li><li>
          <a href="/docs/about/license/">
            License
          </a>
        </li><li>
          <a href="/docs/about/translations/">
            Translations
          </a>
        </li></ul>
  </div></nav>

        </div>

        
          <div class="d-none d-xl-block col-xl-2 bd-toc">
            <ul class="section-nav">
<li class="toc-entry toc-h2"><a href="#append">append</a></li>
<li class="toc-entry toc-h2"><a href="#check">check</a></li>
<li class="toc-entry toc-h2"><a href="#checkall">checkAll</a></li>
<li class="toc-entry toc-h2"><a href="#checkby">checkBy</a></li>
<li class="toc-entry toc-h2"><a href="#checkinvert">checkInvert</a></li>
<li class="toc-entry toc-h2"><a href="#collapseallrows">collapseAllRows</a></li>
<li class="toc-entry toc-h2"><a href="#collapserow">collapseRow</a></li>
<li class="toc-entry toc-h2"><a href="#collapserowbyuniqueid">collapseRowByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#destroy">destroy</a></li>
<li class="toc-entry toc-h2"><a href="#expandallrows">expandAllRows</a></li>
<li class="toc-entry toc-h2"><a href="#expandrow">expandRow</a></li>
<li class="toc-entry toc-h2"><a href="#expandrowbyuniqueid">expandRowByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#filterby">filterBy</a></li>
<li class="toc-entry toc-h2"><a href="#getallselections">getAllSelections</a></li>
<li class="toc-entry toc-h2"><a href="#getdata">getData</a></li>
<li class="toc-entry toc-h2"><a href="#gethiddencolumns">getHiddenColumns</a></li>
<li class="toc-entry toc-h2"><a href="#gethiddenrows">getHiddenRows</a></li>
<li class="toc-entry toc-h2"><a href="#getoptions">getOptions</a></li>
<li class="toc-entry toc-h2"><a href="#getrowbyuniqueid">getRowByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#getscrollposition">getScrollPosition</a></li>
<li class="toc-entry toc-h2"><a href="#getselections">getSelections</a></li>
<li class="toc-entry toc-h2"><a href="#getvisiblecolumns">getVisibleColumns</a></li>
<li class="toc-entry toc-h2"><a href="#hideallcolumns">hideAllColumns</a></li>
<li class="toc-entry toc-h2"><a href="#hidecolumn">hideColumn</a></li>
<li class="toc-entry toc-h2"><a href="#hideloading">hideLoading</a></li>
<li class="toc-entry toc-h2"><a href="#hiderow">hideRow</a></li>
<li class="toc-entry toc-h2"><a href="#insertrow">insertRow</a></li>
<li class="toc-entry toc-h2"><a href="#load">load</a></li>
<li class="toc-entry toc-h2"><a href="#mergecells">mergeCells</a></li>
<li class="toc-entry toc-h2"><a href="#nextpage">nextPage</a></li>
<li class="toc-entry toc-h2"><a href="#prepend">prepend</a></li>
<li class="toc-entry toc-h2"><a href="#prevpage">prevPage</a></li>
<li class="toc-entry toc-h2"><a href="#refresh">refresh</a></li>
<li class="toc-entry toc-h2"><a href="#refreshoptions">refreshOptions</a></li>
<li class="toc-entry toc-h2"><a href="#remove">remove</a></li>
<li class="toc-entry toc-h2"><a href="#removeall">removeAll</a></li>
<li class="toc-entry toc-h2"><a href="#removebyuniqueid">removeByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#resetsearch">resetSearch</a></li>
<li class="toc-entry toc-h2"><a href="#resetview">resetView</a></li>
<li class="toc-entry toc-h2"><a href="#scrollto">scrollTo</a></li>
<li class="toc-entry toc-h2"><a href="#selectpage">selectPage</a></li>
<li class="toc-entry toc-h2"><a href="#showallcolumns">showAllColumns</a></li>
<li class="toc-entry toc-h2"><a href="#showcolumn">showColumn</a></li>
<li class="toc-entry toc-h2"><a href="#showloading">showLoading</a></li>
<li class="toc-entry toc-h2"><a href="#showrow">showRow</a></li>
<li class="toc-entry toc-h2"><a href="#toggledetailview">toggleDetailView</a></li>
<li class="toc-entry toc-h2"><a href="#togglefullscreen">toggleFullscreen</a></li>
<li class="toc-entry toc-h2"><a href="#togglepagination">togglePagination</a></li>
<li class="toc-entry toc-h2"><a href="#toggleview">toggleView</a></li>
<li class="toc-entry toc-h2"><a href="#uncheck">uncheck</a></li>
<li class="toc-entry toc-h2"><a href="#uncheckall">uncheckAll</a></li>
<li class="toc-entry toc-h2"><a href="#uncheckby">uncheckBy</a></li>
<li class="toc-entry toc-h2"><a href="#updatebyuniqueid">updateByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#updatecell">updateCell</a></li>
<li class="toc-entry toc-h2"><a href="#updatecellbyuniqueid">updateCellByUniqueId</a></li>
<li class="toc-entry toc-h2"><a href="#updatecolumntitle">updateColumnTitle</a></li>
<li class="toc-entry toc-h2"><a href="#updateformattext">updateFormatText</a></li>
<li class="toc-entry toc-h2"><a href="#updaterow">updateRow</a></li>
</ul>
          </div>
        

        <main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content api" role="main">
          <h1 class="bd-title" id="content">Methods</h1>
          <p class="bd-lead">The Methods API of Bootstrap Table.</p>
          <div id="gg"></div>

          <p>The calling method syntax: <code class="highlighter-rouge">$('#table').bootstrapTable('method', parameter)</code>.</p>

<h2 id="append">append</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">data</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Append the <code class="highlighter-rouge">data</code> to table.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/append.html">Append</a></p>
  </li>
</ul>

<h2 id="check">check</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">index</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Check a row, the row <code class="highlighter-rouge">index</code> start with 0.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck.html">Check/Uncheck</a></p>
  </li>
</ul>

<h2 id="checkall">checkAll</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Check all current page rows.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck-all.html">Check/Uncheck All</a></p>
  </li>
</ul>

<h2 id="checkby">checkBy</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Check a row by array of values, the params contain:</p>

    <ul>
      <li><code class="highlighter-rouge">field</code>: name of the field used to find records.</li>
      <li><code class="highlighter-rouge">values</code>: array of values for rows to check.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck-by.html">Check/Uncheck By</a></p>
  </li>
</ul>

<h2 id="checkinvert">checkInvert</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Invert check of current page rows. Triggers <code class="highlighter-rouge">onCheckSome</code> and <code class="highlighter-rouge">onUncheckSome</code> events.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-invert.html">Check Invert</a></p>
  </li>
</ul>

<h2 id="collapseallrows">collapseAllRows</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Collapse all rows if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-all-rows.html">Expand/Collapse All Rows</a></p>
  </li>
</ul>

<h2 id="collapserow">collapseRow</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">index</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Collapse the row that has the <code class="highlighter-rouge">index</code> passed by parameter if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-row.html">Expand/Collapse Row</a></p>
  </li>
</ul>

<h2 id="collapserowbyuniqueid">collapseRowByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">uniqueId</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Collapse the row that has the <code class="highlighter-rouge">uniqueId</code> passed by parameter if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-row-by-uniqueid.html">Expand/Collapse Row by uniqueId</a></p>
  </li>
</ul>

<h2 id="destroy">destroy</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Destroy the Bootstrap Table.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/destroy.html">Destroy</a></p>
  </li>
</ul>

<h2 id="expandallrows">expandAllRows</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Expand all rows if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-all-rows.html">Expand/Collapse All Rows</a></p>
  </li>
</ul>

<h2 id="expandrow">expandRow</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">index</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Expand the row that has the <code class="highlighter-rouge">index</code> passed by parameter if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-row.html">Expand/Collapse Row</a></p>
  </li>
</ul>

<h2 id="expandrowbyuniqueid">expandRowByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">uniqueId</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Expand the row that has the <code class="highlighter-rouge">uniqueId</code> passed by parameter if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/expand-collapse-row-by-uniqueid.html">Expand/Collapse Row by uniqueId</a></p>
  </li>
</ul>

<h2 id="filterby">filterBy</h2>

<ul>
  <li><strong>Parameter:</strong>
    <ul>
      <li><code class="highlighter-rouge">filter - An Object of filter</code>
  Default: <code class="highlighter-rouge">{}</code></li>
      <li><code class="highlighter-rouge">options - An Object of options</code>
  Default:
        <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>  {
      'filterAlgorithm': 'and'
  }
</code></pre></div>        </div>
      </li>
    </ul>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>(Can use only in client-side) Filter data in table.
There are multiple ways to filter:</p>
    <ul>
      <li>Leave the options blank to use the <code class="highlighter-rouge">and</code> filter.</li>
      <li>Set the <code class="highlighter-rouge">filterAlgorithm</code> (see at parameter) to <code class="highlighter-rouge">or</code> to use the <code class="highlighter-rouge">or</code> filter.</li>
      <li>Pass a function to the <code class="highlighter-rouge">filterAlgorithm</code> (see at parameter) to use a <code class="highlighter-rouge">custom</code> filter.</li>
    </ul>

    <p><strong>Filter Algorithm</strong></p>

    <ul>
      <li>And
        <ul>
          <li>Filter <code class="highlighter-rouge">{age: 10}</code> to show the data only age is equal to 10.  You can also filter with an array of values, as in: <code class="highlighter-rouge">{age: 10, hairColor: ['blue', 'red', 'green']}</code> to find data where age is equal to 10 and hairColor is either blue, red, or green.</li>
        </ul>
      </li>
      <li>Or
        <ul>
          <li>Filter <code class="highlighter-rouge">{age: 10, name: "santa"}</code> to show all Data which has a age of 10 <strong>or</strong> the name is equals to santa.</li>
        </ul>
      </li>
      <li>Custom
        <ul>
          <li>Filter by your Custom algorithm</li>
          <li>Function parameters:
            <ul>
              <li>Row</li>
              <li>Filters</li>
            </ul>
          </li>
          <li>Return <code class="highlighter-rouge">true</code> to keep the row and return <code class="highlighter-rouge">false</code> to filter the row.</li>
        </ul>
      </li>
    </ul>
  </li>
  <li><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/filter-by.html">Filter By</a></li>
</ul>

<h2 id="getallselections">getAllSelections</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Return all selected rows contain search or filter, when no record selected, an empty array will return.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-all-selections.html">Get All Selections</a></p>
  </li>
</ul>

<h2 id="getdata">getData</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get the loaded data of table at the moment that this method is called</p>

    <ul>
      <li><code class="highlighter-rouge">useCurrentPage</code>: if set to true the method will return the data only in the current page.</li>
      <li><code class="highlighter-rouge">includeHiddenRows</code>: if set to true the method will include the hidden rows.</li>
      <li><code class="highlighter-rouge">unfiltered</code>: if set to true the method will include all data (unfiltered).</li>
      <li><code class="highlighter-rouge">formatted</code>: get the formatted value from the defined <a href="https://bootstrap-table.com/docs/api/column-options/#formatter">formatter</a>.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-data.html">Get Data</a></p>
  </li>
</ul>

<h2 id="gethiddencolumns">getHiddenColumns</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get hidden columns.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-visible-hidden-columns.html">Get Visible/Hidden Columns</a></p>
  </li>
</ul>

<h2 id="gethiddenrows">getHiddenRows</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">show</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get all rows hidden and if you pass the <code class="highlighter-rouge">show</code> parameter <code class="highlighter-rouge">true</code> the rows will be shown again, otherwise, the method only will return the rows hidden.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-hidden-rows.html">Get Hidden Rows</a></p>
  </li>
</ul>

<h2 id="getoptions">getOptions</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Return the options object.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-options.html">Get Options</a></p>
  </li>
</ul>

<h2 id="getrowbyuniqueid">getRowByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">id</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get data from table, the row that contains the <code class="highlighter-rouge">id</code> passed by parameter.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-row-by-unique-id.html">Get Row By Unique Id</a></p>
  </li>
</ul>

<h2 id="getscrollposition">getScrollPosition</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get the current scroll position, the unit is <code class="highlighter-rouge">'px'</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-scroll-position.html">Get Scroll Position</a></p>
  </li>
</ul>

<h2 id="getselections">getSelections</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Return selected rows, when no record selected, an empty array will return.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-selections.html">Get Selections</a></p>
  </li>
</ul>

<h2 id="getvisiblecolumns">getVisibleColumns</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">-</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Get visible columns.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/get-visible-hidden-columns.html">Get Visible/Hidden Columns</a></p>
  </li>
</ul>

<h2 id="hideallcolumns">hideAllColumns</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Hide All the columns.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-all-columns.html">Show/Hide All Columns</a></p>
  </li>
</ul>

<h2 id="hidecolumn">hideColumn</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">field</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Hide the specified <code class="highlighter-rouge">field</code> column.
The parameter can be a string or a array of fields.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-column.html">Show/Hide Column</a></p>
  </li>
</ul>

<h2 id="hideloading">hideLoading</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Hide loading status.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-loading.html">Show/Hide Loading</a></p>
  </li>
</ul>

<h2 id="hiderow">hideRow</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Hide the specified row. The params must contain at least one of the following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index.</li>
      <li><code class="highlighter-rouge">uniqueId</code>: the value of the uniqueId for that row.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-row.html">Show/Hide Row</a></p>
  </li>
</ul>

<h2 id="insertrow">insertRow</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Insert a new row, the params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index to insert into.</li>
      <li><code class="highlighter-rouge">row</code>: the row data.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/insert-row.html">Insert Row</a></p>
  </li>
</ul>

<h2 id="load">load</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">data</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Load the <code class="highlighter-rouge">data</code> to table, the old rows will be removed.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/load.html">Load</a></p>
  </li>
</ul>

<h2 id="mergecells">mergeCells</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Merge some cells to one cell, the params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index.</li>
      <li><code class="highlighter-rouge">field</code>: the field name.</li>
      <li><code class="highlighter-rouge">rowspan</code>: the rowspan count to be merged.</li>
      <li><code class="highlighter-rouge">colspan</code>: the colspan count to be merged.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/merge-cells.html">Merge Cells</a></p>
  </li>
</ul>

<h2 id="nextpage">nextPage</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Go to next page.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/select-prev-next-page.html">Select/Prev/Next Page</a></p>
  </li>
</ul>

<h2 id="prepend">prepend</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">data</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Prepend the <code class="highlighter-rouge">data</code> to table.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/prepend.html">Prepend</a></p>
  </li>
</ul>

<h2 id="prevpage">prevPage</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Go to previous page.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/select-prev-next-page.html">Select/Prev/Next Page</a></p>
  </li>
</ul>

<h2 id="refresh">refresh</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Refresh/reload the remote server data, you can set <code class="highlighter-rouge">{silent: true}</code> to refresh the data silently, and set <code class="highlighter-rouge">{url: newUrl, pageNumber: pageNumber, pageSize: pageSize}</code> to change the url (optional), page number (optional) and page size (optional). To supply query params specific to this request, set <code class="highlighter-rouge">{query: {foo: 'bar'}}</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/refresh.html">Refresh</a></p>
  </li>
</ul>

<h2 id="refreshoptions">refreshOptions</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">options</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Refresh the table <code class="highlighter-rouge">options</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/refresh-options.html">Refresh Options</a></p>
  </li>
</ul>

<h2 id="remove">remove</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Remove data from table, the params contain two properties:</p>

    <ul>
      <li><code class="highlighter-rouge">field</code>: the field name of remove rows. If <code class="highlighter-rouge">$index</code> is not in your fields, you can use this special field <code class="highlighter-rouge">$index</code> to remove rows by row index.</li>
      <li><code class="highlighter-rouge">values</code>: the array of values for rows which should be removed. If you use the special field <code class="highlighter-rouge">$index</code>, you can pass an array of indexes.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/remove.html">Remove</a></p>
  </li>
</ul>

<h2 id="removeall">removeAll</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Remove all data from table.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/remove-all.html">Remove All</a></p>
  </li>
</ul>

<h2 id="removebyuniqueid">removeByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">id</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Remove data from table, the row that contains the <code class="highlighter-rouge">id</code> passed by parameter.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/remove-by-unique-id.html">Remove By Unique Id</a></p>
  </li>
</ul>

<h2 id="resetsearch">resetSearch</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">text</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Set the search <code class="highlighter-rouge">text</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/reset-search.html">Reset Search</a></p>
  </li>
</ul>

<h2 id="resetview">resetView</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Reset the Bootstrap Table view, for example reset the table height, the params contain:</p>

    <ul>
      <li><code class="highlighter-rouge">height</code>: the height of the table.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/reset-view.html">Reset View</a></p>
  </li>
</ul>

<h2 id="scrollto">scrollTo</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">value|object</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <ul>
      <li>value
        <ul>
          <li>Scroll to the number <code class="highlighter-rouge">value</code> position, the unit is <code class="highlighter-rouge">'px'</code>, set <code class="highlighter-rouge">'bottom'</code> means scroll to the bottom.</li>
        </ul>
      </li>
      <li>object
        <ul>
          <li>Scroll to the unit (<code class="highlighter-rouge">px</code> or <code class="highlighter-rouge">rows (index starts by 0)</code>)
Default: <code class="highlighter-rouge">{unit: 'px', value: 0}</code></li>
        </ul>
      </li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/scroll-to.html">Scroll To</a></p>
  </li>
</ul>

<h2 id="selectpage">selectPage</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">page</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Go to the a specified <code class="highlighter-rouge">page</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/select-prev-next-page.html">Select/Prev/Next Page</a></p>
  </li>
</ul>

<h2 id="showallcolumns">showAllColumns</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Show All the columns.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-all-columns.html">Show/Hide All Columns</a></p>
  </li>
</ul>

<h2 id="showcolumn">showColumn</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">field</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Show the specified <code class="highlighter-rouge">field</code> column.
The parameter can be a string or a array of fields.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-column.html">Show/Hide Column</a></p>
  </li>
</ul>

<h2 id="showloading">showLoading</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Show loading status.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-loading.html">Show/Hide Loading</a></p>
  </li>
</ul>

<h2 id="showrow">showRow</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Show the specified row. The params must contain at least one of the following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index.</li>
      <li><code class="highlighter-rouge">uniqueId</code>: the value of the uniqueId for that row.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/show-hide-row.html">Show/Hide Row</a></p>
  </li>
</ul>

<h2 id="toggledetailview">toggleDetailView</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">index</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Toggle the row that has the <code class="highlighter-rouge">index</code> passed by parameter if the detail view option is set to <code class="highlighter-rouge">true</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/toggle-detail-view.html">Toggle Detail View</a></p>
  </li>
</ul>

<h2 id="togglefullscreen">toggleFullscreen</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Toggle fullscreen.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/toggle-fullscreen.html">Toggle Fullscreen</a></p>
  </li>
</ul>

<h2 id="togglepagination">togglePagination</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Toggle the pagination option.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/toggle-pagination.html">Toggle Pagination</a></p>
  </li>
</ul>

<h2 id="toggleview">toggleView</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Toggle the card/table view.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/toggle-view.html">Toggle View</a></p>
  </li>
</ul>

<h2 id="uncheck">uncheck</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">index</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Uncheck a row, the row <code class="highlighter-rouge">index</code> start with 0.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck.html">Check/Uncheck</a></p>
  </li>
</ul>

<h2 id="uncheckall">uncheckAll</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">undefined</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Uncheck all current page rows.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck-all.html">Check/Uncheck All</a></p>
  </li>
</ul>

<h2 id="uncheckby">uncheckBy</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Uncheck a row by array of values, the params contain:</p>

    <ul>
      <li><code class="highlighter-rouge">field</code>: name of the field used to find records.</li>
      <li><code class="highlighter-rouge">values</code>: array of values for rows to uncheck.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/check-uncheck-by.html">Check/Uncheck By</a></p>
  </li>
</ul>

<h2 id="updatebyuniqueid">updateByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update the specified row(s), each params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">id</code>: a row id where the id should be the <code class="highlighter-rouge">uniqueId</code> field assigned to the table.</li>
      <li><code class="highlighter-rouge">row</code>: the new row data.</li>
      <li><code class="highlighter-rouge">replace</code> (optional): set to <code class="highlighter-rouge">true</code> to replace the row instead of extending.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-by-unique-id.html">Update By Unique Id</a></p>
  </li>
</ul>

<h2 id="updatecell">updateCell</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update one cell, the params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index.</li>
      <li><code class="highlighter-rouge">field</code>: the field name.</li>
      <li><code class="highlighter-rouge">value</code>: the new field value.</li>
    </ul>

    <p>To disable table re-initialization you can set <code class="highlighter-rouge">{reinit: false}</code>.</p>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-cell.html">Update Cell</a></p>
  </li>
</ul>

<h2 id="updatecellbyuniqueid">updateCellByUniqueId</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update the specified cell(s), each params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">id</code>: row id where the id should be the <code class="highlighter-rouge">uniqueId</code> field assigned to the table.</li>
      <li><code class="highlighter-rouge">field</code>: field name of the cell to be updated.</li>
      <li><code class="highlighter-rouge">value</code>: new value of the cell.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-cell-by-unique-id.html">Update Cell By Unique Id</a></p>
  </li>
</ul>

<h2 id="updatecolumntitle">updateColumnTitle</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update the field title of column, the params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">field</code>: the field name.</li>
      <li><code class="highlighter-rouge">title</code>: the field title.</li>
    </ul>
  </li>
  <li>
    <p><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-column-title.html">Update Column Title</a></p>
  </li>
</ul>

<h2 id="updateformattext">updateFormatText</h2>

<ul>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">formatName, text</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update the localizations format text.</p>
  </li>
  <li><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-format-text.html">Update Format Text</a>
    <h2 id="updaterow">updateRow</h2>
  </li>
  <li>
    <p><strong>Parameter:</strong> <code class="highlighter-rouge">params</code></p>
  </li>
  <li>
    <p><strong>Detail:</strong></p>

    <p>Update the specified row(s), each params contain following properties:</p>

    <ul>
      <li><code class="highlighter-rouge">index</code>: the row index to be updated.</li>
      <li><code class="highlighter-rouge">row</code>: the new row data.</li>
      <li><code class="highlighter-rouge">replace</code> (optional): set to <code class="highlighter-rouge">true</code> to replace the row instead of extending.</li>
    </ul>
  </li>
  <li><strong>Example:</strong> <a href="https://examples.bootstrap-table.com/#methods/update-row.html">Update Row</a></li>
</ul>

        </main>
      </div>
    </div>

    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js" integrity="sha512-bLT0Qm9VnAYZDflyKcBaQ2gg0hSYNQrJ8RilYldYQ1FxQYoCLtUjuuRuZo+fjqhx/qtq/1itJ0C2ejDxltZVFg==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<script async defer src="https://buttons.github.io/buttons.js"></script><script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
$(function () {
  $('.bd-content.api a').attr('target', '_blank')
})
</script><script src="https://gg.wenzhixin.net.cn/bootstrap-table/gg.js"></script>
<script src="/assets/js/docs.min.js?m=1"></script>

<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-132747866-1"></script>
<script>
  window.dataLayer = window.dataLayer || []
  function gtag() {window.dataLayer.push(arguments)}
  gtag('js', new Date())
  gtag('config', 'UA-132747866-1')
</script>

  </body>
</html>