This site is currently undergoing maintenance, so instances of "RelativityOne" may still be present. You may also experience 404 errors, search disruptions, and temporary style changes.

Last date modified: 2026-Sep-09

Interface: IContentHighlightingCardApiRenderErrorEvent<CType, CTType>

Event indicating that the invocation of the content highlighting feature's render function failed

Type Parameters

• CTypeextendsIQueueItem = IQueueItem

Type of queue item displayed

• CTTypeextendsIQueueItem = IQueueItem

Type of queue item loaded into a viewer instance

Properties

abort

readonlyabort: AbortSignal

Abort signal associated with content highlighting


api

readonlyapi: IReviewInterfaceApi

Review Interface API


content

readonlycontent: IContentDescription<CType, CTType>

Content associated with the render


error

readonlyerror: Error

Error associated with the failure


highlightingApi?

readonlyoptionalhighlightingApi: IContentHighlightingApi

Content highlighting API instance for the content (if available)

This will be undefined if the content type is ContentType.CollectionError or ContentType.EmptyQueue or if the relevant viewer type does not support content highlighting.


viewerType

readonlyviewerType: string

Viewer type the render function was invoked for

Feedback