1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="core">
<name>page.len()</name>
<summary>Get / set the table's page length.</summary>
<since>1.10</since>
<type type="function">
<signature>page.len()</signature>
<description>Get the page length of the table. Note that if multiple tables are available in the API's context, the page length of the first table in the context will be used. Use `dt-api table()` if you are working with multiple tables in a single API context.</description>
<returns type="integer">Current page length. Note that if `-1` was passed as a set parameter, indicating all records are to be shown, then `-1` will also be returned by this method.</returns>
</type>
<type type="function">
<signature>page.len( set )</signature>
<description>Set the page length to be used for the display</description>
<parameter type="integer" name="set">
Page length to set. Use `-1` to show all records, effectively disabling paging.
</parameter>
<returns type="DataTables.Api">DataTables API instance</returns>
</type>
<description>
This method is used quite simply to get and set the length of the paging used by DataTables for display. Please note that this is only relevant when `dt-init paging` is enabled in the table.
The special number `-1` can be used as a set parameter, and then returned by the get format of this method, to indicate that all rows in the DataTable will be displayed.
Please be aware that this method sets the page to be shown - it does not actually perform the re-display of the table. In order to have the newly set page shown use the `dt-api draw()` method, which can be called simply as a chained method of the `dt-api len()` method's returned object - for example `table.page.len( 25 ).draw();`.
</description>
<example title="Allow user to click on two elements to select if all records should be shown or just 10"><![CDATA[
var table = $('#example').DataTable();
$('#all').on( 'click', function () {
table.page.len( -1 ).draw();
} );
$('#_10').on( 'click', function () {
table.page.len( 10 ).draw();
} );
]]></example>
<related type="init">paging</related>
<related type="init">pageLength</related>
<related type="init">lengthChange</related>
<related type="api">page.info()</related>
</dt-api>
|
