starling-framework

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TextField | starling-framework</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">starling-framework</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../index.html">starling</a> </li> <li> <a href="../modules/starling.text.html">text</a> </li> <li> <a href="starling.text.textfield.html">TextField</a> </li> </ul> <h1>Class TextField</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A TextField displays text, using either standard true type fonts, custom bitmap fonts, or a custom text representation.</p> </div> <p>Access the <code>format</code> property to modify the appearance of the text, like the font name and size, a color, the horizontal and vertical alignment, etc. The border property is useful during development, because it lets you see the bounds of the TextField.</p> <p>There are several types of fonts that can be displayed:</p> <ul> <li>Standard TrueType fonts. This renders the text just like a conventional Flash TextField. It is recommended to embed the font, since you cannot be sure which fonts are available on the client system, and since this enhances rendering quality. Simply pass the font name to the corresponding property.</li> <li>Bitmap fonts. If you need speed or fancy font effects, use a bitmap font instead. That is a font that has its glyphs rendered to a texture atlas. To use it, first register the font with the method <code>registerBitmapFont</code>, and then pass the font name to the corresponding property of the text field.</li> <li>Custom text compositors. Any class implementing the <code>ITextCompositor</code> interface can be used to render text. If the two standard options are not sufficient for your needs, such a compositor might do the trick.</li> </ul> <p>For bitmap fonts, we recommend one of the following tools:</p> <ul> <li>Windows: <a href="http://www.angelcode.com/products/bmfont">Bitmap Font Generator</a> from Angel Code (free). Export the font data as an XML file and the texture as a png with white characters on a transparent background (32 bit).</li> <li>Mac OS: <a href="http://glyphdesigner.71squared.com">Glyph Designer</a> from 71squared or <a href="http://http://www.bmglyph.com">bmGlyph</a> (both commercial). They support Starling natively.</li> <li>Cross-Platform: <a href="http://kvazars.com/littera/">Littera</a> or <a href="http://renderhjs.net/shoebox/">ShoeBox</a> are great tools, as well. Both are free to use and were built with Adobe AIR.</li> </ul> <p>When using a bitmap font, the 'color' property is used to tint the font texture. This works by multiplying the RGB values of that property with those of the texture's pixel. If your font contains just a single color, export it in plain white and change the 'color' property to any value you like (it defaults to zero, which means black). If your font contains multiple colors, change the 'color' property to <code>Color.WHITE</code> to get the intended result.</p> <p> <strong>Batching of TextFields</strong></p> <p>Normally, TextFields will require exactly one draw call. For TrueType fonts, you cannot avoid that; bitmap fonts, however, may be batched if you enable the "batchable" property. This makes sense if you have several TextFields with short texts that are rendered one after the other (e.g. subsequent children of the same sprite), or if your bitmap font texture is in your main texture atlas.</p> <p>The recommendation is to activate "batchable" if it reduces your draw calls (use the StatsDisplay to check this) AND if the text fields contain no more than about 15-20 characters. For longer texts, the batching would take up more CPU time than what is saved by avoiding the draw calls.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="starling.display.displayobjectcontainer.html" class="tsd-signature-type">DisplayObjectContainer</a> <ul class="tsd-hierarchy"> <li> <span class="target">TextField</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.text.textfield.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#alpha" class="tsd-kind-icon">alpha</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#autoscale" class="tsd-kind-icon">auto<wbr>Scale</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#autosize" class="tsd-kind-icon">auto<wbr>Size</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#base" class="tsd-kind-icon">base</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#batchable" class="tsd-kind-icon">batchable</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#blendmode" class="tsd-kind-icon">blend<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#border" class="tsd-kind-icon">border</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#bounds" class="tsd-kind-icon">bounds</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#filter" class="tsd-kind-icon">filter</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#format" class="tsd-kind-icon">format</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#height" class="tsd-kind-icon">height</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#is3d" class="tsd-kind-icon">is3D</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#ishorizontalautosize" class="tsd-kind-icon">is<wbr>Horizontal<wbr>Auto<wbr>Size</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#ishtmltext" class="tsd-kind-icon">is<wbr>Html<wbr>Text</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#isverticalautosize" class="tsd-kind-icon">is<wbr>Vertical<wbr>Auto<wbr>Size</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#mask" class="tsd-kind-icon">mask</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#maskinverted" class="tsd-kind-icon">mask<wbr>Inverted</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#numchildren" class="tsd-kind-icon">num<wbr>Children</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#options" class="tsd-kind-icon">options</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#parent" class="tsd-kind-icon">parent</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#pivotx" class="tsd-kind-icon">pivotX</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#pivoty" class="tsd-kind-icon">pivotY</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#pixelsnapping" class="tsd-kind-icon">pixel<wbr>Snapping</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#requiresredraw" class="tsd-kind-icon">requires<wbr>Redraw</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#root" class="tsd-kind-icon">root</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#rotation" class="tsd-kind-icon">rotation</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#scale" class="tsd-kind-icon">scale</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#scalex" class="tsd-kind-icon">scaleX</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#scaley" class="tsd-kind-icon">scaleY</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#skewx" class="tsd-kind-icon">skewX</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#skewy" class="tsd-kind-icon">skewY</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#stage" class="tsd-kind-icon">stage</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#style" class="tsd-kind-icon">style</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#text" class="tsd-kind-icon">text</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#textbounds" class="tsd-kind-icon">text<wbr>Bounds</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#touchgroup" class="tsd-kind-icon">touch<wbr>Group</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#touchable" class="tsd-kind-icon">touchable</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#transformationmatrix" class="tsd-kind-icon">transformation<wbr>Matrix</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#transformationmatrix3d" class="tsd-kind-icon">transformation<wbr>Matrix3D</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#usehandcursor" class="tsd-kind-icon">use<wbr>Hand<wbr>Cursor</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#visible" class="tsd-kind-icon">visible</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#width" class="tsd-kind-icon">width</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#wordwrap" class="tsd-kind-icon">word<wbr>Wrap</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#x" class="tsd-kind-icon">x</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#y" class="tsd-kind-icon">y</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#defaultcompositor" class="tsd-kind-icon">default<wbr>Compositor</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#defaulttextureformat" class="tsd-kind-icon">default<wbr>Texture<wbr>Format</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#addchild" class="tsd-kind-icon">add<wbr>Child</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#addchildat" class="tsd-kind-icon">add<wbr>Child<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#alignpivot" class="tsd-kind-icon">align<wbr>Pivot</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#broadcastevent" class="tsd-kind-icon">broadcast<wbr>Event</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#broadcasteventwith" class="tsd-kind-icon">broadcast<wbr>Event<wbr>With</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#contains" class="tsd-kind-icon">contains</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#dispatcheventwith" class="tsd-kind-icon">dispatch<wbr>Event<wbr>With</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.text.textfield.html#dispose" class="tsd-kind-icon">dispose</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#drawtobitmapdata" class="tsd-kind-icon">draw<wbr>ToBitmap<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.text.textfield.html#getbounds" class="tsd-kind-icon">get<wbr>Bounds</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#getchildat" class="tsd-kind-icon">get<wbr>Child<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#getchildbyname" class="tsd-kind-icon">get<wbr>Child<wbr>ByName</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#getchildindex" class="tsd-kind-icon">get<wbr>Child<wbr>Index</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#gettextbounds" class="tsd-kind-icon">get<wbr>Text<wbr>Bounds</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#gettransformationmatrix" class="tsd-kind-icon">get<wbr>Transformation<wbr>Matrix</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#gettransformationmatrix3d" class="tsd-kind-icon">get<wbr>Transformation<wbr>Matrix3D</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_alpha" class="tsd-kind-icon">get_<wbr>alpha</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_autoscale" class="tsd-kind-icon">get_<wbr>auto<wbr>Scale</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_autosize" class="tsd-kind-icon">get_<wbr>auto<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_base" class="tsd-kind-icon">get_<wbr>base</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_batchable" class="tsd-kind-icon">get_<wbr>batchable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_blendmode" class="tsd-kind-icon">get_<wbr>blend<wbr>Mode</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#get_border" class="tsd-kind-icon">get_<wbr>border</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_bounds" class="tsd-kind-icon">get_<wbr>bounds</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_filter" class="tsd-kind-icon">get_<wbr>filter</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_format" class="tsd-kind-icon">get_<wbr>format</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_height" class="tsd-kind-icon">get_<wbr>height</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_is3d" class="tsd-kind-icon">get_<wbr>is3D</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_ishorizontalautosize" class="tsd-kind-icon">get_<wbr>is<wbr>Horizontal<wbr>Auto<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_ishtmltext" class="tsd-kind-icon">get_<wbr>is<wbr>Html<wbr>Text</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_isverticalautosize" class="tsd-kind-icon">get_<wbr>is<wbr>Vertical<wbr>Auto<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_mask" class="tsd-kind-icon">get_<wbr>mask</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_maskinverted" class="tsd-kind-icon">get_<wbr>mask<wbr>Inverted</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_name" class="tsd-kind-icon">get_<wbr>name</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_numchildren" class="tsd-kind-icon">get_<wbr>num<wbr>Children</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_options" class="tsd-kind-icon">get_<wbr>options</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_parent" class="tsd-kind-icon">get_<wbr>parent</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_pivotx" class="tsd-kind-icon">get_<wbr>pivotX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_pivoty" class="tsd-kind-icon">get_<wbr>pivotY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_pixelsnapping" class="tsd-kind-icon">get_<wbr>pixel<wbr>Snapping</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_requiresredraw" class="tsd-kind-icon">get_<wbr>requires<wbr>Redraw</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_root" class="tsd-kind-icon">get_<wbr>root</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_rotation" class="tsd-kind-icon">get_<wbr>rotation</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_scale" class="tsd-kind-icon">get_<wbr>scale</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_scalex" class="tsd-kind-icon">get_<wbr>scaleX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_scaley" class="tsd-kind-icon">get_<wbr>scaleY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_skewx" class="tsd-kind-icon">get_<wbr>skewX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_skewy" class="tsd-kind-icon">get_<wbr>skewY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_stage" class="tsd-kind-icon">get_<wbr>stage</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_style" class="tsd-kind-icon">get_<wbr>style</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_text" class="tsd-kind-icon">get_<wbr>text</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_textbounds" class="tsd-kind-icon">get_<wbr>text<wbr>Bounds</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_touchgroup" class="tsd-kind-icon">get_<wbr>touch<wbr>Group</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_touchable" class="tsd-kind-icon">get_<wbr>touchable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_transformationmatrix" class="tsd-kind-icon">get_<wbr>transformation<wbr>Matrix</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_transformationmatrix3d" class="tsd-kind-icon">get_<wbr>transformation<wbr>Matrix3D</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_usehandcursor" class="tsd-kind-icon">get_<wbr>use<wbr>Hand<wbr>Cursor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_visible" class="tsd-kind-icon">get_<wbr>visible</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_width" class="tsd-kind-icon">get_<wbr>width</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_wordwrap" class="tsd-kind-icon">get_<wbr>word<wbr>Wrap</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_x" class="tsd-kind-icon">get_<wbr>x</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#get_y" class="tsd-kind-icon">get_<wbr>y</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#globaltolocal" class="tsd-kind-icon">global<wbr>ToLocal</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#globaltolocal3d" class="tsd-kind-icon">global<wbr>ToLocal3D</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.text.textfield.html#hittest" class="tsd-kind-icon">hit<wbr>Test</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#hittestmask" class="tsd-kind-icon">hit<wbr>Test<wbr>Mask</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#local3dtoglobal" class="tsd-kind-icon">local3DTo<wbr>Global</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#localtoglobal" class="tsd-kind-icon">local<wbr>ToGlobal</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removechild" class="tsd-kind-icon">remove<wbr>Child</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removechildat" class="tsd-kind-icon">remove<wbr>Child<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removechildren" class="tsd-kind-icon">remove<wbr>Children</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removeeventlisteners" class="tsd-kind-icon">remove<wbr>Event<wbr>Listeners</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#removefromparent" class="tsd-kind-icon">remove<wbr>From<wbr>Parent</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.text.textfield.html#render" class="tsd-kind-icon">render</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#setchildindex" class="tsd-kind-icon">set<wbr>Child<wbr>Index</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#setrequiresrecomposition" class="tsd-kind-icon">set<wbr>Requires<wbr>Recomposition</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#setrequiresredraw" class="tsd-kind-icon">set<wbr>Requires<wbr>Redraw</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_alpha" class="tsd-kind-icon">set_<wbr>alpha</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_autoscale" class="tsd-kind-icon">set_<wbr>auto<wbr>Scale</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_autosize" class="tsd-kind-icon">set_<wbr>auto<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_batchable" class="tsd-kind-icon">set_<wbr>batchable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_blendmode" class="tsd-kind-icon">set_<wbr>blend<wbr>Mode</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.text.textfield.html#set_border" class="tsd-kind-icon">set_<wbr>border</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_filter" class="tsd-kind-icon">set_<wbr>filter</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_format" class="tsd-kind-icon">set_<wbr>format</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_height" class="tsd-kind-icon">set_<wbr>height</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_ishtmltext" class="tsd-kind-icon">set_<wbr>is<wbr>Html<wbr>Text</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_mask" class="tsd-kind-icon">set_<wbr>mask</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_maskinverted" class="tsd-kind-icon">set_<wbr>mask<wbr>Inverted</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_name" class="tsd-kind-icon">set_<wbr>name</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_pivotx" class="tsd-kind-icon">set_<wbr>pivotX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_pivoty" class="tsd-kind-icon">set_<wbr>pivotY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_pixelsnapping" class="tsd-kind-icon">set_<wbr>pixel<wbr>Snapping</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_rotation" class="tsd-kind-icon">set_<wbr>rotation</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_scale" class="tsd-kind-icon">set_<wbr>scale</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_scalex" class="tsd-kind-icon">set_<wbr>scaleX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_scaley" class="tsd-kind-icon">set_<wbr>scaleY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_skewx" class="tsd-kind-icon">set_<wbr>skewX</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_skewy" class="tsd-kind-icon">set_<wbr>skewY</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_style" class="tsd-kind-icon">set_<wbr>style</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_text" class="tsd-kind-icon">set_<wbr>text</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_touchgroup" class="tsd-kind-icon">set_<wbr>touch<wbr>Group</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_touchable" class="tsd-kind-icon">set_<wbr>touchable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_transformationmatrix" class="tsd-kind-icon">set_<wbr>transformation<wbr>Matrix</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_usehandcursor" class="tsd-kind-icon">set_<wbr>use<wbr>Hand<wbr>Cursor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_visible" class="tsd-kind-icon">set_<wbr>visible</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_width" class="tsd-kind-icon">set_<wbr>width</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_wordwrap" class="tsd-kind-icon">set_<wbr>word<wbr>Wrap</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_x" class="tsd-kind-icon">set_<wbr>x</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.text.textfield.html#set_y" class="tsd-kind-icon">set_<wbr>y</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#sortchildren" class="tsd-kind-icon">sort<wbr>Children</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#swapchildren" class="tsd-kind-icon">swap<wbr>Children</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.text.textfield.html#swapchildrenat" class="tsd-kind-icon">swap<wbr>Children<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#getbitmapfont" class="tsd-kind-icon">get<wbr>Bitmap<wbr>Font</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#getcompositor" class="tsd-kind-icon">get<wbr>Compositor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#get_defaultcompositor" class="tsd-kind-icon">get_<wbr>default<wbr>Compositor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#get_defaulttextureformat" class="tsd-kind-icon">get_<wbr>default<wbr>Texture<wbr>Format</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#registerbitmapfont" class="tsd-kind-icon">register<wbr>Bitmap<wbr>Font</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#registercompositor" class="tsd-kind-icon">register<wbr>Compositor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#set_defaultcompositor" class="tsd-kind-icon">set_<wbr>default<wbr>Compositor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#set_defaulttextureformat" class="tsd-kind-icon">set_<wbr>default<wbr>Texture<wbr>Format</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#unregisterbitmapfont" class="tsd-kind-icon">unregister<wbr>Bitmap<wbr>Font</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#unregistercompositor" class="tsd-kind-icon">unregister<wbr>Compositor</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.text.textfield.html#updateembeddedfonts" class="tsd-kind-icon">update<wbr>Embedded<wbr>Fonts</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new <wbr>Text<wbr>Field<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, text<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><a href="starling.text.textformat.html" class="tsd-signature-type">TextFormat</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.text.textfield.html" class="tsd-signature-type">TextField</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/text/TextField.d.ts#L81">lib/starling/text/TextField.d.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a new text field with the given properties.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>width: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>height: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <a href="starling.text.textformat.html" class="tsd-signature-type">TextFormat</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="starling.text.textfield.html" class="tsd-signature-type">TextField</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="alpha" class="tsd-anchor"></a> <h3>alpha</h3> <div class="tsd-signature tsd-kind-icon">alpha<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#alpha">alpha</a></p> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L331">lib/starling/display/DisplayObject.d.ts:331</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The opacity of the object. 0 = transparent, 1 = opaque. @default 1</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="autoscale" class="tsd-anchor"></a> <h3>auto<wbr>Scale</h3> <div class="tsd-signature tsd-kind-icon">auto<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/text/TextField.d.ts#L162">lib/starling/text/TextField.d.ts:162</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Indicates whether the font size is automatically reduced if the complete text does not fit into the TextField. @default false</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="autosize" class="tsd-anchor"></a> <h3>auto<wbr>Size</h3> <div class="tsd-signature tsd-kind-icon">auto<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/text/TextField.d.ts#L169">lib/starling/text/TextField.d.ts:169</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies the type of auto-sizing the TextField will do. Note that any auto-sizing will implicitly deactivate all auto-scaling. @default none</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="base" class="tsd-anchor"></a> <h3>base</h3> <div class="tsd-signature tsd-kind-icon">base<span class="tsd-signature-symbol">:</span> <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#base">base</a></p> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L417">lib/starling/display/DisplayObject.d.ts:417</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The topmost object in the display tree the object is part of.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="batchable" class="tsd-anchor"></a> <h3>batchable</h3> <div class="tsd-signature tsd-kind-icon">batchable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/text/TextField.d.ts#L187">lib/starling/text/TextField.d.ts:187</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Indicates if TextField should be batched on rendering.</p> </div> <p>This works only with bitmap fonts, and it makes sense only for TextFields with no more than 10-15 characters. Otherwise, the CPU costs will exceed any gains you get from avoiding the additional draw call.</p> <p> @default false</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="blendmode" class="tsd-anchor"></a> <h3>blend<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">blend<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#blendmode"