floater Property

Summary

Floater image of this item.

Syntax
TypeScript
JavaScript
Object.defineProperty(ImageViewerItem.prototype, 'floater', 
	get: function(), 
	set: function(value) 
) 
floater: HTMLCanvasElement; 

Property Value

The floater image of this item. The default value is null.

Remarks

The image viewer supports a floater image that can be dragged with the mouse or touch when ImageViewerFloaterInteractiveMode is used.

The floater outline can be rendered or animated using FloaterRegionRenderMode.

The position, scale, and rotation of the floater can be manipulated with the FloaterTransform property.

FloaterOpacity can be used to set any opacity value for the floater from completely transparent to fully opaque and any values in between.

Changing the value of this property will fire the ItemChanged event with ImageViewerItemChangedReason.Floater.

Floater property of ImageViewer will update this member if this is the active item when the viewer is used in single item mode.

For more information, refer to Image Viewer Items.

Example

The example below will create a floater canvas made from part of the item image and manipulate the transform for it.

Floater.ts
ImageViewer.ts
Floater.js
ImageViewer.js
Floater.html
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewer_FloaterExample { 
   private viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   private run = (viewer: lt.Controls.ImageViewer) => { 
      const item: lt.Controls.ImageViewerItem = viewer.activeItem; 
      const canvas = item.canvas as HTMLCanvasElement; 
      const ctx: CanvasRenderingContext2D = canvas.getContext("2d"); 
      // Select an area to make into a floater 
      const rect: lt.LeadRectD = lt.LeadRectD.create(10, 10, item.size.width / 2, item.size.height / 2); 
      const imageData: ImageData = ctx.getImageData(rect.x, rect.y, rect.width, rect.height); 
      console.log(imageData); 
 
      // Create the floater canvas and fill it with the image data 
      const floater = document.createElement("canvas"); 
      item.floater = floater; 
      floater.width = rect.width; 
      floater.height = rect.height; 
      const floaterCtx: CanvasRenderingContext2D = floater.getContext("2d"); 
      floaterCtx.putImageData(imageData, 0, 0); 
 
      const transform: lt.LeadMatrix = lt.LeadMatrix.identity; 
      transform.rotateAt(30, imageData.width / 2, imageData.height / 2); 
      item.floaterTransform = lt.LeadMatrix.multiply(transform, item.floaterTransform); 
   } 
} 
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/v200/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_FloaterExample { 
   viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   run = (viewer) => { 
      const item = viewer.activeItem; 
      const canvas = item.canvas; 
      const ctx = canvas.getContext("2d"); 
      // Select an area to make into a floater 
      const rect = lt.LeadRectD.create(10, 10, item.size.width / 2, item.size.height / 2); 
      const imageData = ctx.getImageData(rect.x, rect.y, rect.width, rect.height); 
      console.log(imageData); 
 
      // Create the floater canvas and fill it with the image data 
      const floater = document.createElement("canvas"); 
      item.floater = floater; 
      floater.width = rect.width; 
      floater.height = rect.height; 
      const floaterCtx = floater.getContext("2d"); 
      floaterCtx.putImageData(imageData, 0, 0); 
 
      const transform = lt.LeadMatrix.identity; 
      transform.rotateAt(30, imageData.width / 2, imageData.height / 2); 
      item.floaterTransform = lt.LeadMatrix.multiply(transform, item.floaterTransform); 
   } 
} 
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/v200/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 | Floater</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.Floater(); 
 
   }; 
</script> 
</html> 

Requirements

Target Platforms

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

Leadtools.Controls Assembly