Interface: CustomOutsideInViewerOptions

Options for features on the custom outside in viewer

Properties

customStatusPills?

optionalcustomStatusPills: ICustomStatusPillConfig[]

Defines one or more custom status pill to be displayed in the viewer

---

documentMetricKey?

optionaldocumentMetricKey: string

Controls whether the viewer should be treated as a custom viewer when reporting view attributes on the document metric. If this property is set, the value will be used to build the attribute names for the viewer's content_shown, view_time_seconds, error_message, and error_category attributes. It is up to the owner of the viewer to ensure that the relevant attributes are supported on the RelEye schema. If this property is not set, the viewer will be treated as a custom viewer.

For more information about the relevant attributes that need to be supported, see the DynamicAttribute enumeration.

NOTE: If you have not setup RelEye to support the necessary attributes, you should not set this property. Doing so would result in the document metric missing some relevant data.

---

enableContextMenu?

optionalenableContextMenu: boolean

Enables the context menu in the custom viewer.

---

hasHiddenContent?

optionalhasHiddenContent: boolean

Enables display of hidden content in native files (e.g., comments in Word docs)

---

hasHighlights?

optionalhasHighlights: boolean

Enables highlight drawer and highlights on the document

---

hasHighlightSearch?

optionalhasHighlightSearch: boolean

Enable highlight search features in the review interface such as search box and contextual search. Must have hasHighlights set to true to function correctly.

---

hasThumbnails?

optionalhasThumbnails: boolean

Enables thumbnail viewer