class openfl.text.TextLineMetrics

Available on all platforms

The TextLineMetrics class contains information about the text position and measurements of a line of text within a text field. All measurements are in pixels. Objects of this class are returned by the flash.text.TextField.getLineMetrics() method.

Instance Fields

var ascent:Float

The ascent value of the text is the length from the baseline to the top of the line height in pixels.

var descent:Float

The descent value of the text is the length from the baseline to the bottom depth of the line in pixels.

var height:Float

The height value of the text of the selected lines (not necessarily the complete text) in pixels. The height of the text line does not include the gutter height.

var leading:Float

The leading value is the measurement of the vertical distance between the lines of text.

var width:Float

The width value is the width of the text of the selected lines (not necessarily the complete text) in pixels. The width of the text line is not the same as the width of the text field. The width of the text line is relative to the text field width, minus the gutter width of 4 pixels (2 pixels on each side).

var x:Float

The x value is the left position of the first character in pixels. This value includes the margin, indent (if any), and gutter widths.

function new(x:Float, width:Float, height:Float, ascent:Float, descent:Float, leading:Float):Void

Creates a TextLineMetrics object. The TextLineMetrics object contains information about the text metrics of a line of text in a text field. Objects of this class are returned by the flash.text.TextField.getLineMetrics() method.

 *
 * @param x           The left position of the first character in pixels.
 * @param width       The width of the text of the selected lines (not

necessarily the complete text) in pixels.

 * @param height      The height of the text of the selected lines (not

necessarily the complete text) in pixels.

 * @param ascent      The length from the baseline to the top of the line

height in pixels.

 * @param descent     The length from the baseline to the bottom depth of

the line in pixels.

 * @param leading     The measurement of the vertical distance between the

lines of text.