renderLayers Method

Summary

Renders annotation layers using the specified clip rectangle.

Syntax

JavaScript Syntax

AnnRenderingEngine.prototype.renderLayers = function( 
   clipRect, 
   layers, 
   container, 
   runMode 
)

TypeScript Syntax

renderLayers( 
   clipRect: LeadRectD, 
   layers: AnnLayerCollection, 
   container: AnnContainer, 
   runMode: boolean 
): void;

Parameters

clipRect

The destination clip rectangle LeadRectD in container coordinates. The engine will only render into this area. Pass

LeadRectD.Empty if you do not want to use a clip rectangle.

layers

The layers to render.

container

The owner container.

runMode

true to render this container in run mode; otherwise, false.

Remarks

This method uses the mapper in container to calculate the destination rectangle and any other transform to be applied.

The value of runMode controls whether this method renders the thumbs, selection objects and other parts used in design mode of the annotation objects as follows:

To render the current state of the designers "as is" (for example, when performing automation in a viewer), pass false.
Most of the time when burning annotations to an image the design mode parts are not required, so you pass true.

Requirements

Target Platforms

Reference

AnnRenderingEngine Class

AnnRenderingEngine Members

Leadtools.Annotations.Core Namespace

Help Version 19.0.2017.10.27

Leadtools.Annotations.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Core Namespace

Assemblies