Last date modified: 2025-Jul-02

Interface: IViewerCollectionZoomApi

Zoom API for a IViewerCollection

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

Properties

level

readonlylevel: number

Current zoom level


mode

readonlymode: ViewerZoomMode

Current zoom mode

Methods

buildZoomControls()

buildZoomControls(viewer): 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): 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, level?): 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

level?: number

Zoom level (Optional - only required if the mode is ViewerZoomMode.percentage)

Returns

void

Return to top of the page
Feedback