Type Alias: RenderContentHighlightsFn()<VType, CType, CTType, CKType, CVType>

RenderContentHighlightsFn<VType, CType, CTType, CKType, CVType>: (params) => Promise<void>

Content highlighting feature's render function that is responsible for retrieving content highlighting metadata and creating highlight sets and highlights via the provided content highlighting API instance

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

Parameters

• params: IRenderContentHighlightsParameters<VType, CType, CTType, CKType, CVType>

Render parameters

Returns

Promise<void>

Promise that resolves when rendering is complete