highlightPostTag

Type: string

Engine default: "</em>"

Parameter syntax

'highlightPostTag' => 'closing_tag'

highlightPostTag: 'closing_tag'

highlightPostTag: 'closing_tag'

'highlightPostTag': 'closing_tag'

highlightPostTag: "closing_tag"

highlightPostTag: String = "closing_tag"

IndexSettings settings = new IndexSettings()
settings.HighlightPostTag = "closing_tag";

.setHighlightPostTag("closing_tag")

opt.HighlightPostTag("closing_tag")

highlightPostTag = Some("closing_tag")

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# A

The HTML string to insert after the highlighted parts in all highlight and snippet results.

Usage notes#

highlightPostTag needs to be used along with highlightPreTag.

Examples# A

Set default highlight post tag#

Copy

1
2
3
$index->setSettings([
  'highlightPostTag' => '</em>'
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.highlightPostTag, to: "</em>")

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

Override default highlight post tag for the current search#

Copy

1
2
3
$results = $index->search('query', [
  'highlightPostTag' => '</strong>'
]);

1
2
3
4
5
6
7
8
let query = Query("query")
    .set(\.highlightPostTag, to: "</strong>")

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

Did you find this page helpful?

highlightPostTag

About this parameter# Found an issue? Edit this parameter A Edit this parameter

Usage notes#

Examples# Found an issue? Edit this parameter A Edit this parameter

Set default highlight post tag#

Override default highlight post tag for the current search#

On this page

About this parameter# A

Examples# A