Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IExtensionConfig

Defines a Relativity Review extension and its behavior

Hierarchy

  • IExtensionConfig

Index

Properties

Properties

Optional cards

cards: ICardConfig[]

The card configuration(s)

id

id: string

Globally unique extension ID

We suggest using a format that includes your company name and an extension identifier

"examplecompany.testextension"

Optional itemListFieldValueTransforms

itemListFieldValueTransforms: IItemListFieldValueTransform[]

List of item list field value transforms to be used when rendering item lists

Optional itemLoadTransforms

itemLoadTransforms: IItemLoadTransform[]

Defines the configuration for an item load transform on a given viewer type

Optional lifecycle

lifecycle: IExtensionLifecycle

Application lifecycle event handlers

These can be used to optionally configure your extension to execute custom code.

name

name: string

User-friendly name for the extension

"Example Company Test Extension"

Optional viewerContextMenus

viewerContextMenus: function

List of context menu items to be added for the specific ViewerType

Type declaration

Optional viewerToolbarControls

viewerToolbarControls: function

List of toolbar controls to be added to the viewer toolbar for the specific ViewerType

Type declaration

Optional viewers

viewers: IViewerCardConfig[]

Custom viewer type definition(s)

preview

This is an experimental API and not ready for production use. Expect breaking changes in the future.

experimental