API Reference / API Parameters / snippetEllipsisText

Nov. 25, 2021

snippetEllipsisText

Type: string

Engine default: "…" (U+2026)

Parameter syntax

'snippetEllipsisText' => "text"

snippetEllipsisText: 'text'

snippetEllipsisText: 'text'

'snippetEllipsisText': 'text'

snippetEllipsisText: "text"

snippetEllipsisText: String = "text"

IndexSettings settings = new IndexSettings()
settings.SnippetEllipsisText = "text";

.setSnippetEllipsisText("text")

opt.SnippetEllipsisText("text")

snippetEllipsisText = Some("text")

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

String used as an ellipsis indicator when a snippet is truncated.

Usage notes

Defaults to an empty string for all accounts created before February 10^th, 2016.
Defaults to "…" (U+2026, HORIZONTAL ELLIPSIS) for accounts created after that date.

Examples

Set default snippet ellipsis text

Copy

1
2
3
$index->setSettings([
  'snippetEllipsisText' => '…'
]);

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

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

Override default snippet ellipsis text for the current search

Copy

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

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

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

Did you find this page helpful?