public/assets/datatables-fixedheader-3-1-1/docs/option/fixedHeader.headerOffset.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <dt-option library="FixedHeader">
   3         <name>fixedHeader.headerOffset</name>
   4         <summary>Offset the table's fixed header</summary>
   5         <since>3.0.0</since>
   6
   7         <default type="integer" value="0"/>
   8
   9         <type type="integer">
  10                 <description>
  11                         Set the offset (in pixels) of the header element's offset for the scrolling calculations.
  12                 </description>
  13         </type>
  14
  15         <description>
  16                 Many web-pages and apps use a navigation element that has fixed positioning applied to it at the top of the page to to provide quick access to common functions and links for an end user. This needs to be accounted for when using FixedHeader so the offset caused by the fixed element doesn't interrupt the correct positioning of the fixed header.
  17
  18                 This parameter provides a method that you can use to inform FixedHeader that an offset should be applied, and what that offset should be.
  19         </description>
  20
  21         <example title="Set the header offset to a known value"><![CDATA[
  22
  23 $('#example').DataTable( {
  24         fixedHeader: {
  25                 headerOffset: 50
  26         }
  27 } );
  28
  29 ]]></example>
  30
  31         <example title="Use jQuery to calculate a required offset"><![CDATA[
  32
  33 $('#example').DataTable( {
  34         fixedHeader: {
  35                 headerOffset: $('#navMenu').outerHeight()
  36         }
  37 } );
  38
  39 ]]></example>
  40
  41         <related>fh-init fixedHeader.footerOffset</related>
  42         <related>fh-api fixedHeader.headerOffset()</related>
  43 </dt-option>