Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHighlightService

Class for working with IPersistentHighlightSets and IPersistentHighlightTerms

Hierarchy

  • IHighlightService

Index

Methods

Methods

addTerms

  • 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

    • Optional syntax: string

      (optional) The search syntax for the new terms

    Returns void

clearNewHighlightStyling

clearRecentSearchTerm

  • clearRecentSearchTerm(termId: number): 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

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

    Parameters

    • documentId: number

      Document Artifact ID of correlating Persistent Highlight Data

    • Optional 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

  • Retrieves the Persistent Highlight Set data from Relativity Highlight Endpoint

    Parameters

    • documentId: number

      Document Artifact ID of correlating Persistent Highlight Data

    • Optional 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

  • Retrieves the Recent Search Set data

    Returns Promise<IPersistentHighlightSet>

    A promise with all the Recent Search Set data

setActiveViewer

  • Sets active viewer type for highlight service

    deprecated

    Use setupHighlightService instead

    Parameters

    Returns void

setRecentSearchTerm

  • setRecentSearchTerm(term: string, syntax: string, visible?: boolean): 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

    • Optional visible: boolean

      The initital visibility of the term

    Returns void