In This Topic ▼

renderLabel Method

Summary

Renders the specified label.

Syntax

TypeScript

JavaScript

AnnLabelRenderer.prototype.renderLabel = function( 
   mapper, 
   label, 
   operations 
)

renderLabel( 
   mapper: AnnContainerMapper, 
   label: AnnLabel, 
   operations: AnnFixedStateOperations 
): void;

mapper

The mapper object to use for converting coordinates. Must not be null.

label

The label to render. Must not be null.

operations

The fixed state of the owner object.

Remarks

This is the label renderer implementation for this platform. For more information, refer to IAnnLabelRenderer.RenderLabel.

This method is called by the framework to render the text labels of an annotation object. The following is performed by this implementation:

The values of AnnLabel.OriginalPosition is converted to physical coordinates by using mapper.AnnContainerMapper.PointFromContainerCoordinates
The size of the (AnnLabel.Text) label text is measured and clipped against the AnnRenderingEngine.ClipRectangle if the value of AnnLabel.RestrictionMode is not AnnLabelRestriction.None
Finally, the text label is rendered into the AnnRenderingEngine.Context property using the values of the AnnLabel.Font property for the text font style and size, the AnnLabel.Foreground property as the text color and the AnnLabel.Background property as the brush to fill the background of area covered by the text.

Requirements

Help Version 23.0.2024.2.29