Last date modified: 2025-Jul-02

Interface: IContentHighlightingCardApiContentChangeEvent<CType, CTType, PCType, PCTType>

Event indicating that the content displayed by the associated viewer collection has changed

Type Parameters

CTypeextendsIQueueItem = IQueueItem

Type of queue item displayed

CTTypeextendsIQueueItem = IQueueItem

Type of queue item loaded into a viewer instance

PCTypeextendsIQueueItem = IQueueItem

Previous type of queue item displayed

PCTTypeextendsIQueueItem = IQueueItem

Previous type of queue item loaded into a viewer instance

Properties

abort?

readonlyoptionalabort: AbortSignal

Abort signal associated with content highlighting

This will be undefined if content highlighting is not supported


api

readonlyapi: IReviewInterfaceApi

Review Interface API


comparison

readonlycomparison: IContentComparison

Comparison of the new and previous content


content

readonlycontent: IContentDescription<CType, CTType>

Content being displayed


documentMetric

readonlydocumentMetric: IPartialMetric

Document metric

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


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.


previousContent?

readonlyoptionalpreviousContent: IContentDescription<PCType, PCTType>

Content previously being displayed

Return to top of the page
Feedback