burnToRect Method (AnnRenderingEngine)

Summary

Burns the annotation objects in Container to the destination context and destination rectangle.

Syntax

JavaScript Syntax

AnnRenderingEngine.prototype.burnToRect = function(destinationRect)

TypeScript Syntax

burnToRect(destinationRect: LeadRectD): void;

Parameters

destinationRect

The destination rectangle in container coordinates.

Remarks

All visible objects in this container will be drawn into the current context.

This method uses the resolution (DPI) values stored in the container. Use this method when burning the container objects into the context of the image currently being used in the automation.

To burn a container into a context while specifying new resolution (DPI) values, use BurnToRectWithDpi.

Example

This example will create a container, adds a couple of objects and then burn it to a canvas

JavaScript Example

example: function SiteLibrary_DefaultPage$example() { 
   // Get the container 
   var container = this._automation.get_container(); 
 
   var inch = 720.0; 
 
   // Add a red line object, from 1in 1in to 2in 2in 
   var lineObj = new lt.Annotations.Core.AnnPolylineObject(); 
   lineObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   lineObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   lineObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("red"), lt.LeadLengthD.create(1))); 
   container.get_children().add(lineObj); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   var rectObj = new lt.Annotations.Core.AnnRectangleObject(); 
   rectObj.set_rect(lt.LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch)); 
   rectObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("blue"), lt.LeadLengthD.create(1))); 
   rectObj.set_fill(lt.Annotations.Core.AnnSolidColorBrush.create("yellow")); 
   container.get_children().add(rectObj); 
 
   // Add canvas element to the document 
   var width = 400; 
   var height = 400; 
   var canvas = document.createElement("canvas"); 
   canvas.style.width = width + "px"; 
   canvas.style.height = height + "px"; 
   canvas.style.background = "white" 
   canvas.style.border = "1px solid"; 
   document.body.appendChild(canvas); 
 
   // Get the destination rectangle in container coordinates 
   // The canvas DPI is 96, and the units are 1/720 of an inch 
   // So, sizeInUnits = (sizeInPixels / dpi) = size in inches * 720 = size in container units 
   // Or, we can use the annotations mapper, like this 
   var mapper = lt.Annotations.Core.AnnContainerMapper.createDefault(); 
   var rc = lt.LeadRectD.create(0, 0, width, height); 
   rc = mapper.rectToContainerCoordinates(rc); 
 
   // Burn the annotations on this canvas 
 
   // Get its context 
   var context = canvas.getContext("2d"); 
 
   // Create a new rendering engine for this container and context 
   var renderingEngine = new lt.Annotations.Rendering.AnnHtml5RenderingEngine(container, context, false); 
 
   // Burn it 
   renderingEngine.burnToRect(rc); 
 
   // Invalidate 
   this._automation.invalidate(); 
},