MarkLogic Server 11.0 Product Documentation

FacetDefinition functions (FacetDefinition)

Use these functions to build a facet definition for use with jsearch.facets and FacetsSearch.

To use this module in your Server-Side JavaScript code, include a require statement similar to following line in your code:

const jsearch = require("/MarkLogic/jsearch");
   

The order in which you call the methods of this class is significant. You should preserve the order shown in the template below. For details, see Query Design Pattern in the Search Developer's Guide.

The intended usage is as follows, with everything except the call to documents and result being optional.

jsearch.facet()                          // creates a FacetDefinition object
  .where(queries)
  .othersWhere(queries)
  .thisWhere(queries)
  .groupInto(bucketDefinition)
  .orderBy(jsonPropNameOrIndexReference)
  .slice(startPos, endPosPlusOne)
  .map(configOrFuncRef) | .reduce(configOrFuncRef)
  .withOptions(optionsConfig)
    

The where, orderBy, slice, map, reduce, and withOptions methods behave as for a values query.

For details, see jsearch.facets, FacetsSearch, and Including Facets in Search Results in the Search Developer's Guide.