Feedback
Last date modified: 2025-Jul-02
Interface: IContentHighlightingManager
API for interacting with the content highlighting features for a given viewer collection.
Each viewer collection will have its own instance of this manager.
Properties
initialized
readonlyinitialized:boolean
Whether or not the manager has been initialized
viewerCollection
readonlyviewerCollection:IViewerCollection
The viewer collection associated that this manager is associated with
Methods
getCard()
getCard(
featureId):ICard
Retrieves the card for the provided feature ID if one exists
Parameters
• featureId: string
Feature ID
Returns
The card (or undefined if no card exists)
getCardApi()
getCardApi(
featureId):IContentHighlightingCardApi
Retrieves the content highlighting card API for the provided feature ID
Parameters
• featureId: string
Feature ID
Returns
The content highlighting card API
getFeatureVisible()
getFeatureVisible(
id):boolean
Checks whether the provided feature ID is visible
Parameters
• id: string
Feature ID
Returns
boolean
Boolean indicating whether the provided feature is visible or not
getHighlightingApi()
getHighlightingApi(
featureId,viewerType):IContentHighlightingApi
Retrieves the content highlighting API for the provided feature ID and viewer type (if available)
Parameters
• featureId: string
Feature ID
• viewerType: string
Viewer type
Returns
The content highlighting API (or undefined if no API is available)
getRenderStatus()
getRenderStatus(
featureId,viewerType):IContentHighlightingRenderStatus
Retrieves the rendering status for the provided feature ID and viewer type (if available)
Parameters
• featureId: string
Feature ID
• viewerType: string
Viewer type
Returns
IContentHighlightingRenderStatus
The rendering status (or undefined if no API is available)
hideFeature()
hideFeature(
id):void
Sets the visibility of the provided feature ID to false
Parameters
• id: string
Feature ID
Returns
void
reload()
reload(
featureId?):Promise<void>
Reloads the content highlights in the current viewer type for the provided feature ID
Parameters
• featureId?: string
Feature ID
Returns
Promise<void>
Promise that resolves when the reload is compleete
setFeatureVisible()
setFeatureVisible(
id,visible):void
Sets the visibility of the provided feature ID
Parameters
• id: string
Feature ID
• visible: boolean
New value
Returns
void
showFeature()
showFeature(
id):void
Sets the visibility of the provided feature ID to true
Parameters
• id: string
Feature ID
Returns
void
toggleFeatureVisible()
toggleFeatureVisible(
id):boolean
Toggles the visibility of the provided feature ID
Parameters
• id: string
Feature ID
Returns
boolean
Boolean indicating the new visibility value for the feature
