search.Summary

Note:

The content in this help topic pertains to SuiteScript 2.0.

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.0 documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds the values for summary types used by the Column.summary or Filter.summary properties. For more information about each search summary type, see SuiteScript 1.0 Documentation.

Supported Script Types

Client and server scripts

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

Module

N/search Module

Since

2015.2

Values

Value

GROUP

COUNT

SUM

AVG

MIN

MAX

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 mySearchFilter = search.createFilter({
    name: 'entity',
    summary: search.Summary.GROUP
});
...
//Add additional code 

          

Related Topics

N/search Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices