Interface: IZoomApi

API for interacting with the zoom level of a IViewerCardInstance

Methods

resetZoom()

resetZoom(): number

Resets the zoom level to ViewerZoomLimit.ZoomDefault

Returns

number

---

zoomIn()

zoomIn(): number

Zooms the viewer in by ViewerZoomLimit.ZoomStep

If the new zoom level will exceed ViewerZoomLimit.ZoomMaximum, the zoom will be set to ViewerZoomLimit.ZoomMaximum.

Returns

number

The new zoom level

---

zoomLevel()

zoomLevel(): number

The current zoom level

This is a positive integer representing the zoom percentage

Returns

number

---

zoomOut()

zoomOut(): number

Zooms the viewer out by ViewerZoomLimit.ZoomStep

If the new zoom level will be less than ViewerZoomLimit.ZoomMinimum, the zoom will be set to ViewerZoomLimit.ZoomMinimum.

Returns

number

The new zoom level

---

zoomToFit()

zoomToFit(mode): void

Sets the zoom mode, which may result in a change to the current zoom level

Parameters

• mode: ViewerZoomMode

New zoom mode

Returns

void

---

zoomToIndex()

zoomToIndex(level): number

Sets the zoom level

If the provided level exceeds ViewerZoomLimit.ZoomMaximum, the zoom will be set to ViewerZoomLimit.ZoomMaximum. If the provided level is less than ViewerZoomLimit.ZoomMinimum, the zoom will be set to ViewerZoomLimit.ZoomMinimum.

Parameters

• level: number

Positive number representing the new zoom percentage (this will be rounded to the nearest integer)

Returns

number

The new zoom level