Search.../
  1. APIs

setPageSize( )

Sets the dataset's page size.

Description

The setPageSize() function returns a Promise that is resolved when:

  • The current item is saved in the collection (if necessary).
  • The dataset's page size is reset.
  • The dataset is refreshed, and any connected elements have been updated.

Because setting the page size refreshes the dataset, the dataset's current item is reset to the first item in the dataset.

Calling setPageSize() on a write-only dataset causes an error.

Note:
When using a read-write dataset and linked input elements, calling any of the following functions will save any changes made in the linked input elements.

Syntax

function setPageSize(pageSize: number): Promise<void>

setPageSize Parameters

NAME
TYPE
DESCRIPTION
pageSize
number

The new page size.

Returns

Fulfilled - When the page size has been set. Rejected - An error object.

Return Type:

Promise<void>

Related Content:

getPageSize( )

Was this helpful?

Set a dataset's page size

Copy Code
1$w("#myDataset").setPageSize(6)
2  .then( () => {
3    console.log("Page size set.");
4  } )
5  .catch( (err) => {
6    let errMsg = err.message;
7    let errCode = err.code;
8  } );