Interface: IContentHighlightingFeatureConfig

Content highlighting feature configuration parameters

Properties

cardId?

optionalcardId: string

The ID of the feature's content highlighting card

If this property is not provided, no card will be created.

---

cardVisibleFn?

optionalcardVisibleFn: ContentHighlightingCardVisibleFn

Function that the Content Highlighting Framework will use to determine whether or not any associated content highlighting cards should be visible

If this property is specified the supportedViewerTypes property will not be used when determining card visibility.

---

enabled?

optionalenabled: boolean

Whether or not this feature is enabled by default. If this property is not provided, the feature will be enabled by default.

---

id

id: string

Globally unique ID for this feature

---

name

name: string

User-friendly feature name

---

order?

optionalorder: number

The order to use when ordering content highlighting features in the UI. When no order is provided provided, the order will be determined by the order in which features are registered. This is NOT used to order content highlighting feature cards. To control the order of cards, use the order property on the card configuration object.

NOTE: This property is not currently being used, but may be used in the future.

---

renderFn

renderFn: RenderContentHighlightsFn

Function that is responsible for retrieving content highlighting metadata and rendering content highlights via the provided IContentHighlightingApi instance

---

supportedViewerTypes?

optionalsupportedViewerTypes: string[]

Optional array of supported viewer types

If this property is provided, the render function will only be invoked for content loaded into the specified viewer types and any associated content highlighting cards will only be made visible for content loaded into the specified viewer types. If this property is not provided, the render function will be invoked for all content loaded into all viewer types and any associated content highlighting cards will be made visible for all viewer types. This property is ignored when determining card visibility if a cardVisibleFn property is provided.

---

visibleByDefault?

optionalvisibleByDefault: boolean

Whether or not this feature's content highlights should be visible by default

Defaults to true