Interface: IRenderContentHighlightsParameters<VType, CType, CTType, CKType, CVType>

Parameters passed to content highlighting features' render functions

Type Parameters

• VTypeextendsIViewerCardInstance = IViewerCardInstance

Viewer card instance type (defaults to IViewerCardInstance)

• CTypeextendsIQueueItem = IQueueItem

Content queue item type (defaults to IQueueItem)

• CTTypeextendsIQueueItem = IQueueItem

Item loaded into viewer item type (defaults to IQueueItem)

• CKTypeextendsSupportedCacheKeyTypeUnion = any

Cache key type

• CVType = any

Cache value type

Properties

abortSignal

readonlyabortSignal: AbortSignal

Abort signal to use for aborting renders

It is important to check this abort signal at the appropriate times to avoid doing unnecessary work when users navigate away while renders are in progress.

---

api

readonlyapi: IReviewInterfaceApi

Review Interface API

---

cache

readonlycache: ICache<CKType, CVType>

A generic cache for caching metadata

A single cache will be provided to all render function invocations for a given feature on a given queue item. When users navigate to new queue items, a fresh cache object will be created and the old cache will be cleaned up.

---

content

readonlycontent: IContentDescription<CType, CTType>

Description of the content displayed in the viewer collection

---

documentMetric

readonlydocumentMetric: IPartialMetric

Document metric

This can be used to enrich the monitoring data that is reported for the document view.

---

forceRefresh

readonlyforceRefresh: boolean

Whether or not a force refresh is required

When this property is set to true, render functions should re-retrieve fresh metadata and recreate all highlight sets and highlights.

---

highlightingApi?

readonlyoptionalhighlightingApi: IContentHighlightingApi

Content highlighting API instance to use for creating highlights

This will be undefined if the viewer instance does not support content highlighting

---

viewer

readonlyviewer: VType

Viewer associated with the render

---

viewerCollection

readonlyviewerCollection: IViewerCollection

Viewer collection associated with the render

---

workflow

readonlyworkflow: IPerformanceWorkflow

Performance monitoring object that will be reported when render is complete