Options
All
  • Public
  • Public/Protected
  • All
Menu

Architecture

Viewer Architecture

In the Relativity Review Interface, the key architectural components for the viewer are the viewer type and collection.

This page contains the following information:

Viewer type

A viewer type renders a specific form of a Relativity document or file. By default, the Relativity Review Interface includes the following core viewer types:

  • Native Viewer - also called the document viewer. It renders the original document native. Its features include text highlighting and searching, and the ability to render audio, video, and short message files.
  • Image Viewer - renders the images (.jpg or .tif) of a document or file. It includes the ability to use markup sets.
  • Text Viewer - renders the contents of an extracted or long text field on a specific document. Its features include text highlighting and searching.
  • Production Viewer - renders productions of Relativity documents.

Review extensions can also register custom viewer types. For more information, see Custom Viewer Types.

In the Relativity Review Interface, all core viewer types use the same rendering technology unlike the legacy document viewer.

Viewer type sub-components

The viewer architecture is built on the card framework, and viewer types are implemented as special types of cards (IViewerCard). These viewer cards include the following sub-components similar to standard cards:

Viewer card definition

Like standard cards, you define a viewer type using a configuration object. Use the IViewerCardConfig interface to configure viewer types. This interface extends the ICardConfig interface.

Viewer card

A viewer card (IViewerCard) represents a constructed instance of a viewer type. The content of a viewer card is the rendered document or file. The card is added to a Dock component for these reasons:

  • To ensure only a single viewer type is visible at a time.
  • To enable a user to switch between viewer types using the tab UI components.

Viewer card instance

A viewer card instance (IViewerCardInstance) defines the behavior of a card, including how it handles activation, deactivation, document loads, and other events.

In this component, viewer types expose viewer-specific APIs for extensions and interactions with other components. For example, the Image Viewer exposes several markup set-related APIs on its IViewerCardInstance.

Viewer collection

The viewer collection (IViewerCollection) manages a collection of viewers as follows:

  • Listens for events from an IQueuePointer.
  • Coordinates switching between different active viewer types.
  • Loads the correct Relativity document or file into the appropriate viewer.

The viewer types focus only on rendering the content while the navigation complexity is encapsulated in the IQueuePointer and IViewerCollection components.

The viewer collection is also rendered as a ICard. This card includes individual viewer types, and the following sets of cards:

  • Left viewer drawer - contains the Thumbnail, PHS, and Filter cards.
  • Right viewer drawer - empty by default.
  • Bottom viewer drawer - contains the Markup navigator card.

Note: The Relativity Review Interface only supports a single viewer collection. In the future, this application will support multiple viewer collection instances.