ImageViewerInteractiveModes Object

Summary

Defines a collection of ImageViewerInteractiveMode objects.

Syntax
TypeScript
JavaScript
function lt.Controls.ImageViewerInteractiveModes 
	extends lt.LeadCollection 
class lt.Controls.ImageViewerInteractiveModes() 
	extends LeadCollection 
Remarks

ImageViewerInteractiveModes holds the collection of ImageViewerInteractiveMode instances used by an ImageViewer.

Use the various LeadCollection properties and methods to add, insert, remove, get/set and enumerate the items of this class.

ImageViewerInteractiveModes also supports the following:

In applications where only one interactive mode is enabled at a time, the modes are added all at once when the application starts and then the user can select which to enable using a user interface element such as a menu item or a combo box. In these types of applications, the user can enable the desired mode quickly using Enable, EnableByIndex, or EnableById instead of looping through all the items in the collection as shown in the example below.

For more information, refer to Image Viewer Interactive Modes.

Example

This example adds a new rubberband interactive mode that will naturally work in the entire view area, then modifies the existing Pan/Zoom mode (which is at index 0 and receives events first) to only work on the active item's image area.

InteractiveModes.ts
ImageViewer.ts
InteractiveModes.js
ImageViewer.js
InteractiveModes.html
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewer_InteractiveModesExample { 
   private viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   private run = (viewer: lt.Controls.ImageViewer) => { 
      viewer.viewBorderThickness = 5; 
      viewer.viewBorderColor = "blue"; 
      viewer.itemMargin = lt.Controls.ControlPadding.createAll(50); 
      viewer.itemBorderThickness = 5; 
      viewer.rotateAngle = 35; 
 
      // Add a rubber band mode that works across the entire view (blue rectangle) 
      const rubberBandMode: lt.Controls.ImageViewerRubberBandInteractiveMode = new lt.Controls.ImageViewerRubberBandInteractiveMode(); 
      viewer.interactiveModes.add(rubberBandMode); 
 
      // Set panZoom (index 0) to only work on the image (black rectangle) 
      const panZoom: lt.Controls.ImageViewerInteractiveMode = viewer.interactiveModes.findById(lt.Controls.ImageViewerInteractiveMode.panZoomModeId); 
      panZoom.workOnBounds = true; 
      panZoom.item = viewer.activeItem; 
      panZoom.itemPart = lt.Controls.ImageViewerItemPart.content; 
   } 
} 
export class ImageViewer_Example { 
   // LEADTOOLS ImageViewer to be used with this example 
   protected imageViewer: lt.Controls.ImageViewer = null; 
   // Generic state value used by the examples 
   public timesClicked: number = 0; 
 
   constructor(callback?: (viewer: lt.Controls.ImageViewer) => void) { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
 
      // Create an image viewer inside the imageViewerDiv element 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions: lt.Controls.ImageViewerCreateOptions = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      this.imageViewer = new lt.Controls.ImageViewer(createOptions); 
      this.imageViewer.viewVerticalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.viewHorizontalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.autoCreateCanvas = true; 
 
      // Add Pan/Zoom interactive mode 
      // Click and drag to pan, CTRL-Click and drag to zoom in and out 
      this.imageViewer.interactiveModes.add(new lt.Controls.ImageViewerPanZoomInteractiveMode()); 
 
      // Load an image 
      this.imageViewer.imageUrl = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
 
      this.imageViewer.zoom(lt.Controls.ControlSizeMode.fit, .9, this.imageViewer.defaultZoomOrigin); 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.addEventListener("click", () => { 
         this.timesClicked++; 
         // Run the example 
         if (callback) 
            callback(this.imageViewer); 
      }); 
   } 
} 
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewer_InteractiveModesExample { 
   viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   run = (viewer) => { 
      viewer.viewBorderThickness = 5; 
      viewer.viewBorderColor = "blue"; 
      viewer.itemMargin = lt.Controls.ControlPadding.createAll(50); 
      viewer.itemBorderThickness = 5; 
      viewer.rotateAngle = 35; 
 
      // Add a rubber band mode that works across the entire view (blue rectangle) 
      const rubberBandMode = new lt.Controls.ImageViewerRubberBandInteractiveMode(); 
      viewer.interactiveModes.add(rubberBandMode); 
 
      // Set panZoom (index 0) to only work on the image (black rectangle) 
      const panZoom = viewer.interactiveModes.findById(lt.Controls.ImageViewerInteractiveMode.panZoomModeId); 
      panZoom.workOnBounds = true; 
      panZoom.item = viewer.activeItem; 
      panZoom.itemPart = lt.Controls.ImageViewerItemPart.content; 
   } 
} 
export class ImageViewer_Example { 
   // LEADTOOLS ImageViewer to be used with this example 
   imageViewer = null; 
   // Generic state value used by the examples 
   timesClicked = 0; 
 
   constructor(callback) { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
 
      // Create an image viewer inside the imageViewerDiv element 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      this.imageViewer = new lt.Controls.ImageViewer(createOptions); 
      this.imageViewer.viewVerticalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.viewHorizontalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.autoCreateCanvas = true; 
 
      // Add Pan/Zoom interactive mode 
      // Click and drag to pan, CTRL-Click and drag to zoom in and out 
      this.imageViewer.interactiveModes.add(new lt.Controls.ImageViewerPanZoomInteractiveMode()); 
 
      // Load an image 
      this.imageViewer.imageUrl = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
 
      this.imageViewer.zoom(lt.Controls.ControlSizeMode.fit, .9, this.imageViewer.defaultZoomOrigin); 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.addEventListener("click", () => { 
         this.timesClicked++; 
         // Run the example 
         if (callback) 
            callback(this.imageViewer); 
      }); 
   } 
} 
<!doctype html> 
<html lang="en"> 
<title>Controls Example | InteractiveModes</title> 
 
<head> 
   <script src="https://code.jquery.com/jquery-2.2.4.min.js" 
      integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
 
   <script src="../../LT/Leadtools.js"></script> 
   <script src="../../LT/Leadtools.Controls.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Engine.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Designers.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Automation.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Main.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Color.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Core.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Effects.js"></script> 
   <script src="../../LT/Leadtools.Document.js"></script> 
   <script src="../../LT/Leadtools.Document.Viewer.js"></script> 
   <style> 
      body { 
         font-family: 'Segoe UI', sans-serif; 
      } 
 
      #imageViewerDiv { 
         border: 1px solid #888; 
         width: 500px; 
         height: 500px; 
         background-color: #eee; 
      } 
   </style> 
 
   <!-- All demo files are bundled and appended to the window --> 
   <script src="../../bundle.js" type="text/javascript"></script> 
</head> 
 
<body> 
   <p>Press and drag on the image to pan.</p> 
   <p>Hold down the control key and press and drag on the image or pinch with two fingers to zoom in and out.</p> 
   <div> 
      <button type="button" id="exampleButton">Run Example</button> 
   </div> 
   <div id="imageViewerDiv"></div> 
   <div id="output"></div> 
</body> 
 
<script> 
   window.onload = () => { 
      const example = new window.examples.InteractiveMode.InteractiveModes(); 
 
   }; 
</script> 
</html> 
Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.