page.len()

Since: DataTables 1.10

Get / set the table's page length.

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 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 draw() method, which can be called simply as a chained method of the len() method's returned object - for example table.page.len( 25 ).draw();.

Types

function page.len()

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 table() if you are working with multiple tables in a single API context.
Returns:: 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.

function page.len( set )

Description:

Set the page length to be used for the display

Parameters:

Returns:

	Name	Type	Optional
1	`set`	`integer`	No
	Page length to set. Use `-1` to show all records, effectively disabling paging.

DataTables.Api

DataTables API instance

Example

Allow user to click on two elements to select if all records should be shown or just 10:

var table = new DataTable('#myTable');

$('#all').on('click', function () {
	table.page.len(-1).draw();
});

$('#_10').on('click', function () {
	table.page.len(10).draw();
});

The following options are directly related and may also be useful in your application development.

API

page.info()

Options