In This Topic ▼

ImageViewerPanZoomInteractiveMode Object

Summary

Provides interactive pan and zoom user interface functionality to an ImageViewer.

Syntax

TypeScript

JavaScript

function lt.Controls.ImageViewerPanZoomInteractiveMode 
	extends lt.Controls.ImageViewerInteractiveMode

class lt.Controls.ImageViewerPanZoomInteractiveMode() 
	extends ImageViewerInteractiveMode

Remarks

ImageViewerPanZoomInteractiveMode derives from ImageViewerInteractiveMode and adds support for interactive pan and zoom (scale) user interface functionality to an ImageViewer.

This mode subscribes to the following events of the InteractiveService:

PinchStarted
PinchDelta
PinchCompleted
DragStarted
DragDelta
DragCompleted
KeyDown if IsKeyboardEnabled is set to true

When used on a platform that support touch events (such as a mobile phone or a tablet), this object allows you to perform functionality such as panning and zooming with one finger or zooming using a "pinch" two fingers gesture as follows:

Functionality	Members
Pan the image on the viewer using one finger (press and drag to pan) and zoom the image on the viewer using two fingers "pinch" gesture (press two fingers and drag both to zoom). This is the default behavior	Set EnablePan to true, EnableZoom to true and EnablePinchZoom to true (all default values).
Pan the image on the viewer using one finger (press and drag to pan). No zoom.	Set EnablePan to true and EnableZoom to false.
Zoom the image on the viewer using one finger (press and drag to zoom). No pan	Set EnablePan to false, EnableZoom to true and EnablePinchZoom to false.
Zoom the image on the viewer using two fingers "pinch" gesture (press two fingers and drag both to zoom). No pan.	Set EnablePan to false, EnableZoom to true and EnablePinchZoom to true.

When used on a platform that support mouse (such as a desktop), this object allows you to perform functionality such as panning and zooming with the mouse and modifier keys as follows:

Functionality	Members
Pan the image on the viewer using the mouse (press and drag to pan). If the modifier key is pressed, then zoom the image on the viewer instead. This is the default behavior	Set EnablePan to true, EnableZoom to true and ZoomKeyModifier to the modifier key, such as Keys.Control. (all default values).
Pan the image on the viewer using the mouse (press and drag to pan). No zoom.	Set EnablePan to true and EnableZoom to false.
Zoom the image on the viewer using the mouse (press and drag to zoom). No pan	Set EnablePan to false, EnableZoom to true and ZoomKeyModifier to Keys.None.

Along with the above, this mode supports double tapping (or double clicking) to fit the viewer to a predefined ControlSizeMode.

Keyboard panning and zooming can also be enabled using IsKeyboardEnabled and PageKeyModifier.

Using a combination of the above, you can assign separate instances of ImageViewerPanZoomInteractiveMode each with their own options to the left and right mouse using MouseButtons.

This mode uses ImageViewer.ScrollByRestrict to pan. Hence, the rules of RestrictScroll apply to the panning performed by this mode. For example, when RestrictScroll is true, you cannot pan outside the maximum boundaries of the image using this interactive mode. When the value of RestrictScroll is false, you have unlimited pan support using this mode.

This mode uses ImageViewer.Zoom to zoom. This method accepts as a parameter the origin of the zoom operation and you can control this using the ZoomAtWorkBoundsCenter property as follows:

ZoomAtWorkBoundsCenter is set to true: The zoom origin will always be the center of the image.
ZoomAtWorkBoundsCenter is set to false: The zoom origin will be the current mouse or touch position.

This mode performs the main operations in the Pan, Zoom and DoubleTapZoom protected methods. ImageViewer has an ImageViewer.MaximumScaleFactor field and a ImageViewer.MinimumScaleFactor field that define the maximum and minimum scale factor allowed. This mode uses the maximum value defined in ImageViewer.MaximumScaleFactor, but defines its own minimum value set in ImageViewerPanZoomInteractiveMode.MinimumScaleFactor. This is done to ensure that the image is always visible and cannot zoom out to an unreasonable value using this mode. ImageViewerPanZoomInteractiveMode supports inertia scrolling when performing pan. This is disabled by default and can be enabled by accessing the InertiaScrollOptions property. For more information, refer to Image Viewer Interactive Modes.

As is customary with most built-in interactive modes, this mode will set InteractiveEventArgs.IsHandled to true under the following conditions:

A valid drag or pinch motion has started or completed (with PinchStarted, PinchCompleted, DragStarted, or DragCompleted)
PinchDelta or DragDelta is received after a valid starting event is successfully handled and the options of the interactive mode allow an action to be taken

Additionally, InteractiveEventArgs.IsHandled may be set to true if a key press causes the viewer to scroll (through IsKeyboardEnabled and PageKeyModifier) or if DoubleTapZoom is used.

Example

For an example, refer to ImageViewer.InteractiveModes.

Requirements

Target Platforms

Reference

ImageViewerPanZoomInteractiveMode Members

Leadtools.Controls Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.Controls Assembly

Introduction

Getting Started

Namespaces

Leadtools.Controls Namespace

Assemblies