API Reference / API Parameters / restrictHighlightAndSnippetArrays

Feb. 26, 2019

restrictHighlightAndSnippetArrays

Type: boolean

Engine default: false

Parameter syntax

'restrictHighlightAndSnippetArrays' => true|false

restrictHighlightAndSnippetArrays: true|false

restrictHighlightAndSnippetArrays: true|false

'restrictHighlightAndSnippetArrays': True|False

"restrictHighlightAndSnippetArrays": true|false

restrictHighlightAndSnippetArrays: Boolean = true|false

new JSONObject()
  .put("restrictHighlightAndSnippetArrays", true|false)

IndexSettings settings = new IndexSettings()
settings.RestrictHighlightAndSnippetArrays = true|false;

.setRestrictHighlightAndSnippetArrays(true|false)

opt.RestrictHighlightAndSnippetArrays(true|false)

restrictHighlightAndSnippetArrays = Some(true|false)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Restrict highlighting and snippeting to items that matched the query.

Impact on the response:

When false, all items are highlighted/snippeted
When true, only items that matched at least partially are highlighted/snippeted

Examples

Set restrictHighlightAndSnippetArrays default value

Copy

$index->setSettings([
  'restrictHighlightAndSnippetArrays' => true
]);

Override restrictHighlightAndSnippetArrays for the current search

Copy

$results = $index->search('query', [
  'restrictHighlightAndSnippetArrays' => false
]);

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

restrictHighlightAndSnippetArrays

About this parameter

Impact on the response:

Examples

Set restrictHighlightAndSnippetArrays default value

Override restrictHighlightAndSnippetArrays for the current search

Did you find this page helpful?

On this page