labels Property

Summary

Gets the collection of labels to render on top of this AnnContainer.

Syntax

JavaScript Syntax
Object.defineProperty(AnnContainer.prototype, 'labels', 
	get: function() 
) 
TypeScript Syntax
labels: AnnLabel[]; // read-only 

Property Value

A collection of AnnLabels to render on top of this AnnContainer.

Remarks

The labels will be rendered using the global AnnRenderingEngine.ContainerLabelRenderer object. This object is automatically created by the annotation framework and can be usable right away.

The container labels can be used to place text items on top of the container that are not part of the annotations objects. For example, to place legends in a mapping application.

Example

JavaScript Example
example: function SiteLibrary_DefaultPage$example() { 
   var inch = 720.0; 
 
   // Get the container 
   var container = this._automation.get_container(); 
 
   // Add a blue on yellow rectangle from 1in 1in to 2in 2in 
   var rectObj = new lt.Annotations.Core.AnnRectangleObject(); 
   rectObj.set_rect(lt.LeadRectD.create(1 * inch, 1 * 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")); 
   rectObj.set_hyperlink("https://www.leadtools.com/downloads/demos.htm"); 
 
   // Update the object name label 
   var label = rectObj.get_labels()["AnnObjectName"]; 
   label.set_isVisible(true); 
   label.set_offset(lt.LeadPointD.create(-100, -25)); 
   label.set_foreground(lt.Annotations.Core.AnnSolidColorBrush.create("white")); 
   label.set_background(lt.Annotations.Core.AnnSolidColorBrush.create("rgba(0, 0, 0, 0.5)")); 
   label.set_text("My object"); 
 
   // Add it to the container 
   container.get_children().add(rectObj); 
 
   this._automation.invalidate(lt.LeadRectD.get_empty()); 
}, 

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Core Assembly