viewLayout Property

Summary

The view layout used by this ImageViewer.

Syntax
TypeScript
JavaScript
Object.defineProperty(ImageViewer.prototype, 'viewLayout', 
	get: function(), 
	set: function(value) 
) 
viewLayout: ImageViewerViewLayout; 

Property Value

The view layout used by this ImageViewer. The default value is an instance of ImageViewerSingleViewLayout.

Remarks

For more information, refer to Image Viewer Layouts.

Example

This example will add a few items to the ImageViewer and add a button to toggle between a vertical and horizontal layout.

ViewLayout.ts
ImageViewer.ts
ViewLayout.js
ImageViewer.js
ViewLayout.html
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewer_ViewLayoutExample { 
   private viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   private run = (viewer: lt.Controls.ImageViewer) => { 
      let flip: boolean = false; 
      const setLayout = () => { 
         flip = !flip; 
         let layout: lt.Controls.ImageViewerViewLayout; 
         if (flip) { 
            layout = new lt.Controls.ImageViewerVerticalViewLayout(); 
            (layout as lt.Controls.ImageViewerVerticalViewLayout).columns = 2; 
         } 
         else { 
            layout = new lt.Controls.ImageViewerHorizontalViewLayout(); 
            (layout as lt.Controls.ImageViewerHorizontalViewLayout).rows = 2; 
         } 
         viewer.viewLayout = layout; 
      } 
 
      // Set the initial layout 
      setLayout(); 
 
      // Add borders and padding 
      viewer.viewBorderThickness = 2; 
      viewer.itemPadding = lt.Controls.ControlPadding.createAll(20); 
 
      // Clear the items and add 6 new items 
      viewer.beginUpdate(); 
      viewer.items.clear(); 
      for (let i = 0; i < 6; i++) { 
         const item: lt.Controls.ImageViewerItem = new lt.Controls.ImageViewerItem(); 
         item.url = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
         item.text = "Item " + i; 
         viewer.items.add(item); 
      } 
      viewer.endUpdate(); 
 
      // Zoom out so we can see all the items 
      viewer.zoom(lt.Controls.ControlSizeMode.fit, .5, viewer.defaultZoomOrigin); 
 
      // Add a button to update the layout 
      const button = document.createElement("button"); 
      button.innerHTML = "Change Layout"; 
      button.onclick = () => { 
         setLayout(); 
      }; 
      const output = document.getElementById("output"); 
      output.appendChild(button); 
   } 
} 
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_ViewLayoutExample { 
   viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   run = (viewer) => { 
      let flip = false; 
      const setLayout = () => { 
         flip = !flip; 
         let layout; 
         if (flip) { 
            layout = new lt.Controls.ImageViewerVerticalViewLayout(); 
            (layout).columns = 2; 
         } 
         else { 
            layout = new lt.Controls.ImageViewerHorizontalViewLayout(); 
            (layout).rows = 2; 
         } 
         viewer.viewLayout = layout; 
      } 
 
      // Set the initial layout 
      setLayout(); 
 
      // Add borders and padding 
      viewer.viewBorderThickness = 2; 
      viewer.itemPadding = lt.Controls.ControlPadding.createAll(20); 
 
      // Clear the items and add 6 new items 
      viewer.beginUpdate(); 
      viewer.items.clear(); 
      for (let i = 0; i < 6; i++) { 
         const item = new lt.Controls.ImageViewerItem(); 
         item.url = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
         item.text = "Item " + i; 
         viewer.items.add(item); 
      } 
      viewer.endUpdate(); 
 
      // Zoom out so we can see all the items 
      viewer.zoom(lt.Controls.ControlSizeMode.fit, .5, viewer.defaultZoomOrigin); 
 
      // Add a button to update the layout 
      const button = document.createElement("button"); 
      button.innerHTML = "Change Layout"; 
      button.onclick = () => { 
         setLayout(); 
      }; 
      const output = document.getElementById("output"); 
      output.appendChild(button); 
   } 
} 
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 | ViewLayout</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.ImageViewer.ViewLayout(); 
 
   }; 
</script> 
</html> 
Requirements

Target Platforms

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

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