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
openfl.text.TextField.getLineMetrics() method.
For measurements related to the text field containing the line of text
(for example, the "Text Field height" measurement in the diagram), see
openfl.text.TextField.
The following diagram indicates the points and measurements of a text field and the line of text the field contains:
Constructor
new(x:Float, width:Float, height:Float, ascent:Float, descent:Float, leading:Float)
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 openfl.text.TextField.getLineMetrics() method.
Parameters:
x | The left position of the first character in pixels. |
|---|---|
width | The width of the text of the selected lines (not necessarily the complete text) in pixels. |
height | The height of the text of the selected lines (not necessarily the complete text) in pixels. |
ascent | The length from the baseline to the top of the line height in pixels. |
descent | The length from the baseline to the bottom depth of the line in pixels. |
leading | The measurement of the vertical distance between the lines of text. |
Variables
ascent:Float
The ascent value of the text is the length from the baseline to the top of the line height in pixels. See the "Ascent" measurement in the overview diagram for this class.
descent:Float
The descent value of the text is the length from the baseline to the bottom depth of the line in pixels. See the "Descent" measurement in the overview diagram for this class.
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. See the "Line height" measurement in the overview diagram for this class.
leading:Float
The leading value is the measurement of the vertical distance between the lines of text. See the "Leading" measurement in the overview diagram for this class.
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). See the "Text Line width" measurement in the overview diagram for this class.
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. See the "Text Line x-position" in the overview diagram for this class.