Loading TOC...

ValuesSearch.withOptions

ValuesSearch.withOptions(
   $option as object
) as ValuesSearch

Summary

Configure advanced options for a values query.

Parameters
$option The configuration object for enabling special features of the values search.

Usage Notes

You can specify the following properties in the configuration object:
values
An array of string options to pass through to cts.values, cts.valueMatch, cts.valueRanges, or cts.geospatialBoxes for fine-tuning the configuration from the other values search clauses.
qualityWeight
A number specifying the weight for the search.
forestNames
An array of strings for restricting the query to the values of documents in the specified forests.

See Also

Example


var jsearch = require('/MarkLogic/jsearch.sjs');
jsearch.values('price')
  .withOptions({qualityWeight: 2.0})
  .result();
   

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy