PagedData.pageRanges

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The collection of search.PageRange objects that divide the entire result set into smaller groups.

This property includes page range information with the key and label for rendering. Page range indexes start at 0.

Type

search.PageRange[]

This property is read-only.

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/search Module

Since

2016.1

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/search Module Script Samples.

          // Add additional code
...
var mySearch = search.create({
    type: search.Type.CUSTOMER,
    columns: [
        'entityid',
        'email'
    ]
});

var myPagedResults = mySearch.runPaged({
    pageSize: 10
});

var thePageRanges = myPagedResults.pageRanges;

// Use PagedData.fetch(options) to retrieve a page of results (as a
// search.Page object) by index
var theData = myPagedResults.fetch({
    index: 5
});
...
// Add additional code

Syntax

Related Topics