Labels Property (AnnContainer)

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

Syntax

JavaScript

get_labels();
Object.defineProperty('labels');

Property Value

Type	Description
List	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: function SiteLibrary_DefaultPage$example() {
   // Get the container for this automation
   var container = this._automation.get_container();

   var inch = 720.0;

   // Create a couple of labels
   var label = new lt.Annotations.Core.AnnLabel();
   label.set_isVisible(true);
   label.set_originalPosition(lt.LeadPointD.create(1 * inch, 1 * inch));
   label.set_foreground(lt.Annotations.Core.AnnSolidColorBrush.create("red"));
   label.set_background(lt.Annotations.Core.AnnSolidColorBrush.create("rgba(0, 0, 0, 0.5)"));
   label.set_text("Red Label");
   container.get_labels().add(label);

   label = new lt.Annotations.Core.AnnLabel();
   label.set_isVisible(true);
   label.set_originalPosition(lt.LeadPointD.create(4 * inch, 4 * inch));
   label.set_foreground(lt.Annotations.Core.AnnSolidColorBrush.create("blue"));
   label.set_background(lt.Annotations.Core.AnnSolidColorBrush.create("rgba(0, 0, 0, 0.5)"));
   label.set_text("Blue Label");
   container.get_labels().add(label);

   // Show the labels
   this._automation.invalidate(lt.LeadRectD.get_empty());
},

Labels Property (AnnContainer)

Property Value

Reference