Interface IViewerCollectionZoomApi

Zoom API for a IViewerCollection

This class synchronizes zoom across all zoom-enabled IViewerCardInstances in the collection.

Hierarchy

IViewerCollectionZoomApi

Index

Properties

level
mode

Methods

Properties

level

level: number | undefined

Current zoom level

mode

mode: ViewerZoomMode | undefined

Current zoom mode

Methods

buildZoomControls

buildZoomControls(viewer: IViewerCardInstance): IZoomControlCollection

Builds a new IZoomControlCollection for viewer zoom controls that can be added to the top toolbar of a IViewerCardInstance

Parameters
- viewer: IViewerCardInstance
  
  Viewer card instance the controls will be associated with
Returns IZoomControlCollection

The newly built control collection

buildZoomFitControls

buildZoomFitControls(viewer: IViewerCardInstance): IControlCollection

Builds a new IControlCollection for viewer zoom fit controls that can be added to the top toolbar of a IViewerCardInstance

Parameters
- viewer: IViewerCardInstance
  
  Viewer card instance the controls will be associated with
Returns IControlCollection

The newly built control collection

updateZoom

updateZoom(mode: ViewerZoomMode, level?: number): void

Updates the zoom value of the collection so that zoom level can be synchronized across viewer types and persisted to user preferences

Parameters
- mode: ViewerZoomMode
  
  Zoom mode
- Optional level: number
  
  Zoom level (Optional - only required if the mode is ViewerZoomMode.percentage)
Returns void

Send comments on this topic to Relativity documentation