Type Alias: ItemLoadTransformFn()

ItemLoadTransformFn: (api, viewerCard, item, options, performanceWorkflow?, documentMetric?) => IItemLoadTransformResult | Promise<IItemLoadTransformResult>

Function used to transform a IQueueItem into a different item before it is loaded into a viewer card instance

This function is allowed to be synchronous or asynchronous, but because this function is in the document load pipeline, extensions should strive to make it as performant as possible and should apply memoization if possible.

Parameters

• api: IReviewInterfaceApi

Public Review Interface API

• viewerCard: IViewerCard

Viewer card the transform is executing for

• item: IQueueItem

Queue item that would be passed to the viewer card instance's cardLoadItem() method

• options: ILoadOptions

Load options that would be passed to the viewer card instance's cardLoadItem() method. This includes the cancellationToken that can be used wherever it is appropriate.

• performanceWorkflow?: IPerformanceWorkflow

• documentMetric?: IPartialMetric

Returns

IItemLoadTransformResult | Promise<IItemLoadTransformResult>

A transform result defining the new parameters to be passed to the viewer card instance