public/assets/datatables-fixedheader-3-1-1/docs/api/fixedHeader.enable().xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <dt-api library="FixedHeader">
   3         <name>fixedHeader.enable()</name>
   4         <summary>Enable / disable the fixed elements</summary>
   5         <since>3.0.1</since>
   6
   7         <type type="function">
   8                 <signature>fixedHeader.enable( [ enable ] )</signature>
   9                 <parameter type="boolean" name="enable" default="true">
  10                         Flag to indicate if the FixedHeader elements should be enabled or disabled.
  11                 </parameter>
  12                 <returns type="DataTables.Api">
  13                         The DataTables API for chaining
  14                 </returns>
  15                 <description>
  16                         Enable or disable the fixed elements. When disabled, the table will remain static, regardless of end user scrolling.
  17                 </description>
  18         </type>
  19
  20         <description>
  21                 This method can be used to enable, and optionally disable, the table's fixed elements (i.e. header and footer). This can be useful if you wish to hide the table (see also `fh-api fixedHeader.adjust()`) or otherwise manipulate the table in its original state.
  22         </description>
  23
  24         <example title="Disable the FixedHeader"><![CDATA[
  25
  26 var table = $('#myTable').DataTable();
  27
  28 table.fixedHeader.enable( false );
  29
  30 ]]></example>
  31
  32         <related>fh-api fixedHeader.disable()</related>
  33 </dt-api>