public/assets/datatables-scroller-1-4-1/docs/option/scroller.boundaryScale.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <dt-option library="Scroller">
   3         <name>scroller.boundaryScale</name>
   4         <summary>Set the point at which new data will be loaded and drawn</summary>
   5
   6         <type type="number">
   7                 <description>
   8                         The boundary scale to use
   9                 </description>
  10         </type>
  11
  12         <default value="0.5">
  13                 Load new data when scrolled halfway through the current data set.
  14         </default>
  15
  16         <description>
  17                 Scroller uses the boundary scaling factor to decide when to redraw the table - which it typically does before you reach the end of the currently loaded data set (in order to allow the data to look continuous to a user scrolling through the data). If given as 0 then the table will be redrawn whenever the viewport is scrolled, while 1 would not redraw the table until the currently loaded data has all been shown. You will want something in the middle - the default factor of 0.5 is usually suitable.
  18         </description>
  19
  20         <example title="Set a custom boundary scale point"><![CDATA[
  21
  22 $('#example').DataTable( {
  23         scrollY: true,
  24         scroller: {
  25                 boundaryScale: 0.75
  26         }
  27 } );
  28
  29 ]]></example>
  30
  31 </dt-option>