Interface: IHighlightService

Class for working with IPersistentHighlightSets and IPersistentHighlightTerms

Methods

addTerms()

addTerms(setId, terms, syntax?): void

Adds new persistent highlight terms to the set and displays the corresponding highlights

Parameters

• setId: number

The set artifact ID to add the new terms to

• terms: IAddPersistentHighlightTermsToSetRequest[]

The new terms to add

• syntax?: string

(optional) The search syntax for the new terms

Returns

void

---

clearNewHighlightStyling()

clearNewHighlightStyling(persistentHighlightData): IPersistentHighlightSet[]

Removes the new term styling for all terms

Parameters

• persistentHighlightData: IPersistentHighlightSet[]

Array of highlight sets to remove styling on

Returns

IPersistentHighlightSet[]

A promise with all Highlight data

---

clearRecentSearchTerm()

clearRecentSearchTerm(termId): void

Clears out the recent search term that matches the term id

Parameters

• termId: number

id of term to clear

Returns

void

---

clearRecentSearchTerms()

clearRecentSearchTerms(): void

Clears the current recent search terms

Returns

void

---

getAllHighlightData()

getAllHighlightData(documentId, refreshCache?): Promise<IPersistentHighlightSet[]>

Retrieves all Highlight Data, including Persistent Highlight data and Recent Search data

Parameters

• documentId: number

Document Artifact ID of correlating Persistent Highlight Data

• refreshCache?: boolean

(optional) Whether or not to skip the cache and force retrieval from the API (Defaults to false)

Returns

Promise<IPersistentHighlightSet[]>

A promise with all Highlight data

---

getPersistentHighlightSetData()

getPersistentHighlightSetData(documentId, refreshCache?): Promise<IPersistentHighlightSet[]>

Retrieves the Persistent Highlight Set data from Relativity Highlight Endpoint

Parameters

• documentId: number

Document Artifact ID of correlating Persistent Highlight Data

• refreshCache?: boolean

(optional) Whether or not to skip the cache and force retrieval from the API (Defaults to false)

Returns

Promise<IPersistentHighlightSet[]>

A promise with all Persistent Highlight data from Relativity

---

getRecentSearchSetData()

getRecentSearchSetData(): Promise<IPersistentHighlightSet>

Retrieves the Recent Search Set data

Returns

Promise<IPersistentHighlightSet>

A promise with all the Recent Search Set data

---

setActiveViewer()

setActiveViewer(viewerType): void

Sets active viewer type for highlight service

Parameters

• viewerType: RelativityViewerType

current viewer type of viewer

Returns

void

Deprecated

Use setupHighlightService instead

---

setRecentSearchTerm()

setRecentSearchTerm(term, syntax, visible?): Promise<void>

Sets the search term that will be added to the PHS pane

Parameters

• term: string

The term to be added

• syntax: string

The syntax to use for searching

• visible?: boolean

The initital visibility of the term

Returns

Promise<void>