Interface: IContentDescription<QueueItemType, TransformQueueItemType>

Metadata describing the content displayed by a specific viewer collection at a given moment in time

Type Parameters

• QueueItemTypeextendsIQueueItem = IQueueItem

Type of queue item displayed

• TransformQueueItemTypeextendsIQueueItem = IQueueItem

Type of queue item loaded into a viewer instance

Properties

item?

readonlyoptionalitem: QueueItemType

Queue item being displayed

This will be undefined if the content type is ContentType.CollectionError or ContentType.EmptyQueue.

---

type

readonlytype: ContentType

Content type

---

viewerOptions?

readonlyoptionalviewerOptions: object

Viewer-specific metadata

This will be undefined if the content type is ContentType.CollectionError or ContentType.EmptyQueue.

itemLoadedInViewer?

readonlyoptionalitemLoadedInViewer: TransformQueueItemType

Queue item that was loaded into the viewer instance

This could differ from the top-level item property when item load transforms have changed the specific content being loaded into the viewer for a given queue item. This will be undefined if the content type is ContentType.CollectionError or ContentType.EmptyQueue.

productionArtifactId?

readonlyoptionalproductionArtifactId: number

Artifact ID of the production being viewed

This may be set even if the viewer type is not RelativityViewerType.Production. In this scenario, this value indicates the queue pointer's current value.

productionType?

readonlyoptionalproductionType: string

Type of production being used

This may be set even if the viewer type is not RelativityViewerType.Production. In this scenario, this value indicates the queue pointer's current value.

textFieldArtifactId?

readonlyoptionaltextFieldArtifactId: number

Artifact ID of the text field being viewed

This may be set even if the viewer type is not RelativityViewerType.Text. In this scenario, this value indicates the queue pointer's current value.

---

viewerType?

readonlyoptionalviewerType: string

Viewer type the content is being displayed in

This will be undefined if the content type is ContentType.CollectionError or ContentType.EmptyQueue.