openfl/lib/openfl/text/TextLineMetrics.d.ts

A fast, productive library for 2D cross-platform development.

declare namespace openfl.text {
	
	
	/**
	 * 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.
	 */
	export class TextLineMetrics {
		
		
		/**
		 * The ascent value of the text is the length from the baseline to the top of
		 * the line height in pixels.
		 */
		public ascent:number;
		
		/**
		 * The descent value of the text is the length from the baseline to the
		 * bottom depth of the line in pixels.
		 */
		public descent:number;
		
		/**
		 * 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.
		 */
		public height:number;
		
		/**
		 * The leading value is the measurement of the vertical distance between the
		 * lines of text.
		 */
		public leading:number;
		
		/**
		 * 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).
		 */
		public width:number;
		
		/**
		 * The x value is the left position of the first character in pixels. This
		 * value includes the margin, indent (if any), and gutter widths.
		 */
		public x:number;
		
		
		/**
		 * 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.
		 */
		public constructor (x:number, width:number, height:number, ascent:number, descent:number, leading:number);
		
		
	}
	
	
}


export default openfl.text.TextLineMetrics;