AnnBatesStampTranslator Object

Summary

AnnBatesStampTranslator defines a translator that converts the Bates stamp elements to a string expression. It can also convert a string expression to Bates stamp elements that can be saved and loaded using AnnBatesStampComposer.

Syntax
TypeScript
JavaScript
function lt.Annotations.BatesStamp.AnnBatesStampTranslator 
class lt.Annotations.BatesStamp.AnnBatesStampTranslator() 
Remarks

This class is used by AnnBatesStampComposer when saving or loading. It can also convert Bates stamp elements to/from a string.

A text expression is composed of the following symbols:

In this instance, the type is a Bates stamp number with 6 digits. Start is set to use all digits, and set to start from 1 with the auto increment feature. The prefix text is "before" and the suffix text is "after". This expression produces: "before000001after".

If the text expression does not conform to the format of either AnnBatesDateTime or AnnBatesNumber, then it is an AnnBatesText element. An example of AnnBatesText is "This is some text".

Provided below is an example of different Bates stamp elements that are converted to a string using AnnBatesStampTranslator: {{BatesDateTime*Local*MM/dd/yyyy}} {{BatesNumber*6*1*1*1*before*after}} This is some text. This expression renders as "01/11/1111 before000001after This is some text".

Example

This example translates Bates stamp elements to a string expression, and then loads it again.

AnnBatesStampTranslator.ts
BatesStampHelper.ts
AnnBatesStampTranslator.js
BatesStampHelper.js
AnnBatesStampTranslator.html
import { BatesStampHelper } from "../utilities/BatesStampHelper"; 
 
export class BatesStampTranslator_Example { 
   constructor() { 
      const helper = new BatesStampHelper(); 
      helper.run(this.translate); 
   } 
 
   private translate = () => { 
      //Create Bates stamp translator instance 
      const translator: lt.Annotations.BatesStamp.AnnBatesStampTranslator = new lt.Annotations.BatesStamp.AnnBatesStampTranslator(); 
 
      //Create some Bates stamp elements to test on translator 
      const batesDateTime: lt.Annotations.BatesStamp.AnnBatesDateTime = new lt.Annotations.BatesStamp.AnnBatesDateTime(); 
      batesDateTime.currentDateTime = new Date(); 
 
      const batesNumber: lt.Annotations.BatesStamp.AnnBatesNumber = new lt.Annotations.BatesStamp.AnnBatesNumber(); 
      batesNumber.autoIncrement = true; 
      batesNumber.startNumber = 3; 
      batesNumber.numberOfDigits = 9; 
      batesNumber.prefixText = "beforeText"; 
      batesNumber.suffixText = "afterText"; 
      batesNumber.useAllDigits = true; 
 
      const batesText: lt.Annotations.BatesStamp.AnnBatesText = lt.Annotations.BatesStamp.AnnBatesText.create("This is test"); 
 
      let elements: lt.Annotations.BatesStamp.IAnnBatesElement[] = [batesDateTime, batesNumber, batesText]; 
      const elementsExpression = translator.writeElementsToString(elements); 
 
      //Print the expression 
      alert(elementsExpression); // the output will be "{{BatesDateTime*Local*}}{{BatesNumber*9*1*3*1*beforeText*afterText}}This is test" 
 
      //Load the Bates stamp elements from the expression again 
      elements = translator.readFromString(elementsExpression); 
 
      //Print the count of loaded elements to make sure the load is correct 
      alert(elements.length); // the output will be "3" 
   } 
} 
export class BatesStampHelper { 
   protected _automation: lt.Annotations.Automation.AnnAutomation; 
   // Image viewer 
   private _viewer: lt.Controls.ImageViewer; 
 
   constructor() { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
   } 
 
   public run(callback?: (automation: lt.Annotations.Automation.AnnAutomation) => void): void { 
      // Create the viewer 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions: lt.Controls.ImageViewerCreateOptions = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      const viewer: lt.Controls.ImageViewer = new lt.Controls.ImageViewer(createOptions); 
      viewer.autoCreateCanvas = true; 
      this._viewer = viewer; 
 
      // PanZoom interactive mode 
      const panZoom: lt.Controls.ImageViewerPanZoomInteractiveMode = new lt.Controls.ImageViewerPanZoomInteractiveMode(); 
 
      // Create an instance of the Automation control object that works with LEADTOOLS ImageViewer 
      const imageViewerAutomationControl: lt.Demos.Annotations.ImageViewerAutomationControl = new lt.Demos.Annotations.ImageViewerAutomationControl(); 
      // Attach our image viewer 
      imageViewerAutomationControl.imageViewer = viewer; 
 
      // Set the image viewer interactive mode 
      const automationInteractiveMode: lt.Demos.Annotations.AutomationInteractiveMode = new lt.Demos.Annotations.AutomationInteractiveMode(); 
      automationInteractiveMode.automationControl = imageViewerAutomationControl; 
 
      // Set the image URL 
      viewer.imageUrl = "http://demo.leadtools.com/images/png/pngimage.png"; 
 
      // Create and set up the automation manager using the HTML5 rendering engine 
      const renderingEngine: lt.Annotations.Rendering.AnnHtml5RenderingEngine = new lt.Annotations.Rendering.AnnHtml5RenderingEngine(); 
      const manager: lt.Annotations.Automation.AnnAutomationManager = lt.Annotations.Automation.AnnAutomationManager.create(renderingEngine); 
 
      // Create default automation objects 
      manager.createDefaultObjects(); 
 
      // Add the objects to the objects select element 
      const currentObjectIdSelect = document.getElementById("currentObjectIdSelect") as HTMLSelectElement; 
      // Add the PanZoom option 
      currentObjectIdSelect.options[currentObjectIdSelect.options.length] = new Option("Pan/Zoom", lt.Annotations.Engine.AnnObject.none.toString()); 
 
      const automationObjCount: number = manager.objects.count; 
      for (let i = 0; i < automationObjCount; i++) { 
         // Get the object 
         const automationObj: lt.Annotations.Automation.AnnAutomationObject = manager.objects.item(i); 
 
         // Add its name to the select element 
         const name: string = automationObj.name; 
         const id: number = automationObj.id; 
         currentObjectIdSelect.options[currentObjectIdSelect.options.length] = new Option(name, id.toString()); 
      } 
 
      // Hook to its change event 
      currentObjectIdSelect.addEventListener("change", () => { 
         // Get the object ID 
         const id: number = parseInt(currentObjectIdSelect.options[currentObjectIdSelect.selectedIndex].value); 
 
         // Set it as the current object in the manager 
         manager.currentObjectId = id; 
 
         // If this is the "Pan/Zoom" option, then back to pan zoom, otherwise, set our automation control 
         if (id == lt.Annotations.Engine.AnnObject.none) { 
            viewer.defaultInteractiveMode = panZoom; 
         } 
         else { 
            viewer.defaultInteractiveMode = automationInteractiveMode; 
         } 
      }); 
 
      // When the current object ID changes, we need to update our select 
      manager.add_currentObjectIdChanged((sender, e) => { 
         const currentObjectId = manager.currentObjectId; 
         for (let i = 0; i < currentObjectIdSelect.options.length; i++) { 
            const id: number = parseInt(currentObjectIdSelect.options[i].value); 
            if (id === currentObjectId) { 
               currentObjectIdSelect.selectedIndex = i; 
               break; 
            } 
         } 
      }); 
 
      // Pan zoom by default 
      viewer.defaultInteractiveMode = panZoom; 
 
      // set up the automation (will create the container as well) 
      const automation: lt.Annotations.Automation.AnnAutomation = new lt.Annotations.Automation.AnnAutomation(manager, imageViewerAutomationControl); 
      this._automation = automation; 
 
      // Add handler to update the container size when the image size changes 
      viewer.itemChanged.add((sender, e) => { 
         const container: lt.Annotations.Engine.AnnContainer = automation.container; 
         container.size = container.mapper.sizeToContainerCoordinates(viewer.imageSize); 
 
         //Create new canvas data provider for the new image 
         const canvasDataProvider: lt.Demos.Annotations.CanvasDataProvider = new lt.Demos.Annotations.CanvasDataProvider(viewer.activeItem.canvas); 
         imageViewerAutomationControl.automationDataProvider = canvasDataProvider; 
 
      }); 
 
      // set up this automation as the active one 
      this._automation.active = true; 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.onclick = () => { 
         if(callback) 
            callback(this._automation); 
      } 
   } 
} 
import { BatesStampHelper } from "../utilities/BatesStampHelper"; 
 
export class BatesStampTranslator_Example { 
   constructor() { 
      const helper = new BatesStampHelper(); 
      helper.run(this.translate); 
   } 
 
   translate = () => { 
      //Create Bates stamp translator instance 
      const translator = new lt.Annotations.BatesStamp.AnnBatesStampTranslator(); 
 
      //Create some Bates stamp elements to test on translator 
      const batesDateTime = new lt.Annotations.BatesStamp.AnnBatesDateTime(); 
      batesDateTime.currentDateTime = new Date(); 
 
      const batesNumber = new lt.Annotations.BatesStamp.AnnBatesNumber(); 
      batesNumber.autoIncrement = true; 
      batesNumber.startNumber = 3; 
      batesNumber.numberOfDigits = 9; 
      batesNumber.prefixText = "beforeText"; 
      batesNumber.suffixText = "afterText"; 
      batesNumber.useAllDigits = true; 
 
      const batesText = lt.Annotations.BatesStamp.AnnBatesText.create("This is test"); 
 
      let elements = [batesDateTime, batesNumber, batesText]; 
      const elementsExpression = translator.writeElementsToString(elements); 
 
      //Print the expression 
      alert(elementsExpression); // the output will be "{{BatesDateTime*Local*}}{{BatesNumber*9*1*3*1*beforeText*afterText}}This is test" 
 
      //Load the Bates stamp elements from the expression again 
      elements = translator.readFromString(elementsExpression); 
 
      //Print the count of loaded elements to make sure the load is correct 
      alert(elements.length); // the output will be "3" 
   } 
} 
export class BatesStampHelper { 
   _automation; 
   // Image viewer 
   _viewer; 
 
   constructor() { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
   } 
 
   run(callback){ 
      // Create the viewer 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions  = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      const viewer = new lt.Controls.ImageViewer(createOptions); 
      viewer.autoCreateCanvas = true; 
      this._viewer = viewer; 
 
      // PanZoom interactive mode 
      const panZoom = new lt.Controls.ImageViewerPanZoomInteractiveMode(); 
 
      // Create an instance of the Automation control object that works with LEADTOOLS ImageViewer 
      const imageViewerAutomationControl = new lt.Demos.Annotations.ImageViewerAutomationControl(); 
      // Attach our image viewer 
      imageViewerAutomationControl.imageViewer = viewer; 
 
      // Set the image viewer interactive mode 
      const automationInteractiveMode = new lt.Demos.Annotations.AutomationInteractiveMode(); 
      automationInteractiveMode.automationControl = imageViewerAutomationControl; 
 
      // Set the image URL 
      viewer.imageUrl = "http://demo.leadtools.com/images/png/pngimage.png"; 
 
      // Create and set up the automation manager using the HTML5 rendering engine 
      const renderingEngine= new lt.Annotations.Rendering.AnnHtml5RenderingEngine(); 
      const manager = lt.Annotations.Automation.AnnAutomationManager.create(renderingEngine); 
 
      // Create default automation objects 
      manager.createDefaultObjects(); 
 
      // Add the objects to the objects select element 
      const currentObjectIdSelect = document.getElementById("currentObjectIdSelect"); 
      // Add the PanZoom option 
      currentObjectIdSelect.options[currentObjectIdSelect.options.length] = new Option("Pan/Zoom", lt.Annotations.Engine.AnnObject.none.toString()); 
 
      const automationObjCount = manager.objects.count; 
      for (let i = 0; i < automationObjCount; i++) { 
         // Get the object 
         const automationObj = manager.objects.item(i); 
 
         // Add its name to the select element 
         const name = automationObj.name; 
         const id = automationObj.id; 
         currentObjectIdSelect.options[currentObjectIdSelect.options.length] = new Option(name, id.toString()); 
      } 
 
      // Hook to its change event 
      currentObjectIdSelect.addEventListener("change", () => { 
         // Get the object ID 
         const id = parseInt(currentObjectIdSelect.options[currentObjectIdSelect.selectedIndex].value); 
 
         // Set it as the current object in the manager 
         manager.currentObjectId = id; 
 
         // If this is the "Pan/Zoom" option, then back to pan zoom, otherwise, set our automation control 
         if (id == lt.Annotations.Engine.AnnObject.none) { 
            viewer.defaultInteractiveMode = panZoom; 
         } 
         else { 
            viewer.defaultInteractiveMode = automationInteractiveMode; 
         } 
      }); 
 
      // When the current object ID changes, we need to update our select 
      manager.add_currentObjectIdChanged((sender, e) => { 
         const currentObjectId = manager.currentObjectId; 
         for (let i = 0; i < currentObjectIdSelect.options.length; i++) { 
            const id = parseInt(currentObjectIdSelect.options[i].value); 
            if (id === currentObjectId) { 
               currentObjectIdSelect.selectedIndex = i; 
               break; 
            } 
         } 
      }); 
 
      // Pan zoom by default 
      viewer.defaultInteractiveMode = panZoom; 
 
      // set up the automation (will create the container as well) 
      const automation = new lt.Annotations.Automation.AnnAutomation(manager, imageViewerAutomationControl); 
      this._automation = automation; 
 
      // Add handler to update the container size when the image size changes 
      viewer.itemChanged.add((sender, e) => { 
         const container = automation.container; 
         container.size = container.mapper.sizeToContainerCoordinates(viewer.imageSize); 
 
         //Create new canvas data provider for the new image 
         const canvasDataProvider = new lt.Demos.Annotations.CanvasDataProvider(viewer.activeItem.canvas); 
         imageViewerAutomationControl.automationDataProvider = canvasDataProvider; 
 
      }); 
 
      // set up this automation as the active one 
      this._automation.active = true; 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.onclick = () => { 
         if(callback) 
            callback(this._automation); 
      } 
   } 
} 
<!doctype html> 
<html lang="en"> 
<title>BatesStamp Example | Translator</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.Annotations.BatesStamp.js"></script> 
   <script src="../LT/Leadtools.Demos.js"></script> 
   <script src="../LT/Leadtools.Demos.Annotations.js"></script> 
   <style> 
      #imageViewerDiv { 
         border: 1px solid #000000; 
         width: 800px; 
         height: 800px; 
         background-color: #7F7F7F; 
      } 
   </style> 
   <!-- All demo files are bundled and appended to the window --> 
   <script src="../../bundle.js" type="text/javascript"></script> 
</head> 
 
<body> 
   <p>Either Pan/Zoom or Annotations mode. In annotations mode, draw new objects or edit them.</p> 
   <div> 
     <select id="currentObjectIdSelect"></select> 
   </div> 
   <div> 
     <input type="button" id="exampleButton" value="Example" /> 
     <label id="exampleLabel" /> 
   </div> 
   <div id="imageViewerDiv" /> 
 </body> 
 
<script> 
   window.onload = () => new window.examples.BatesStamp.Translator(); 
</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.Annotations.BatesStamp Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.