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

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_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browseObjects, 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, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey 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

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

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.restrictHighlightAndSnippetArrays, to: true)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Override restrictHighlightAndSnippetArrays for the current search

Copy

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

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.restrictHighlightAndSnippetArrays, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Did you find this page helpful?

restrictHighlightAndSnippetArrays

About this parameter

Impact on the response:

Examples

Set restrictHighlightAndSnippetArrays default value

Override restrictHighlightAndSnippetArrays for the current search

On this page