<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Text - Pixi.JS</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="Pixi.JS"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="../classes/ColorStepFilter.html">ColorStepFilter</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/GrayFilter.html">GrayFilter</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PIXI.PixiShader.html">PIXI.PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/PolyK._convex.html">PolyK._convex</a></li>
<li><a href="../classes/PolyK._PointInTriangle.html">PolyK._PointInTriangle</a></li>
<li><a href="../classes/PolyK.AjaxRequest.html">PolyK.AjaxRequest</a></li>
<li><a href="../classes/PolyK.InteractionData.html">PolyK.InteractionData</a></li>
<li><a href="../classes/PolyK.InteractionManager.html">PolyK.InteractionManager</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li>
<li><a href="../classes/Spine.html">Spine</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Sprite™.html">Sprite™</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
<li><a href="../classes/Text.html">Text</a></li>
<li><a href="../classes/Texture.html">Texture</a></li>
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/PIXI.html">PIXI</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Text Class</h1>
<div class="box meta">
<div class="extends">
Extends Sprite
</div>
<div class="foundat">
Defined in: <a href="../files/src_pixi_text_Text.js.html#l5"><code>src/pixi/text/Text.js:5</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>A Text Object will create a line(s) of text to split a line you can use '\n'</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Text" class="method item">
<h3 class="name"><code>Text</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>text</code>
</li>
<li class="arg">
<code class="optional">[style]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l5"><code>src/pixi/text/Text.js:5</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">text</code>
<span class="type">String</span>
<div class="param-description">
<p>The copy that you would like the text to display</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[style]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The style parameters</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[font]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>default 'bold 20pt Arial' The style and size of the font</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[fill='black']</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A canvas fillstyle that will be used on the text eg 'red', '#00FF00'</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[align='left']</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An alignment of the multiline text ('left', 'center' or 'right')</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[stroke]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[strokeThickness=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A number that represents the thickness of the stroke. Default is 0 (no stroke)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[wordWrap=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Indicates if word wrap should be used</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[wordWrapWidth=100]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The width at which text will wrap</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method">
<a href="#method_setStyle">setStyle</a>
</li>
<li class="index-item method">
<a href="#method_setText">setText</a>
</li>
<li class="index-item method private">
<a href="#method_updateText">updateText</a>
</li>
<li class="index-item method private">
<a href="#method_updateTexture">updateTexture</a>
</li>
<li class="index-item method private">
<a href="#method_updateTransform">updateTransform</a>
</li>
<li class="index-item method private">
<a href="#method_wordWrap">wordWrap</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_destroy" class="method item">
<h3 class="name"><code>destroy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>destroyTexture</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l260"><code>src/pixi/text/Text.js:260</code></a>
</p>
</div>
<div class="description">
<p>Destroys this text object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">destroyTexture</code>
<span class="type">Boolean</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_setStyle" class="method item">
<h3 class="name"><code>setStyle</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[style]</code>
</li>
<li class="arg">
<code>[style.font='bold</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l38"><code>src/pixi/text/Text.js:38</code></a>
</p>
</div>
<div class="description">
<p>Set the style of the text</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[style]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The style parameters</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[fill='black']</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A canvas fillstyle that will be used on the text eg 'red', '#00FF00'</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[align='left']</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An alignment of the multiline text ('left', 'center' or 'right')</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[stroke='black']</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[strokeThickness=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A number that represents the thickness of the stroke. Default is 0 (no stroke)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[wordWrap=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Indicates if word wrap should be used</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[wordWrapWidth=100]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The width at which text will wrap</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">[style.font='bold</code>
<span class="type">String</span>
<div class="param-description">
<p>20pt Arial'] The style and size of the font</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setText" class="method item">
<h3 class="name"><code>setText</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>text</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l65"><code>src/pixi/text/Text.js:65</code></a>
</p>
</div>
<div class="description">
<p>Set the copy for the text object. To split a line you can use '\n'</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">text</code>
<span class="type">String</span>
<div class="param-description">
<p>The copy that you would like the text to display</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_updateText" class="method item private">
<h3 class="name"><code>updateText</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l77"><code>src/pixi/text/Text.js:77</code></a>
</p>
</div>
<div class="description">
<p>Renders text</p>
</div>
</div>
<div id="method_updateTexture" class="method item private">
<h3 class="name"><code>updateTexture</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l148"><code>src/pixi/text/Text.js:148</code></a>
</p>
</div>
<div class="description">
<p>Updates texture size based on canvas size</p>
</div>
</div>
<div id="method_updateTransform" class="method item private">
<h3 class="name"><code>updateTransform</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l167"><code>src/pixi/text/Text.js:167</code></a>
</p>
</div>
<div class="description">
<p>Updates the transfor of this object</p>
</div>
</div>
<div id="method_wordWrap" class="method item private">
<h3 class="name"><code>wordWrap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>text</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_text_Text.js.html#l216"><code>src/pixi/text/Text.js:216</code></a>
</p>
</div>
<div class="description">
<p>Applies newlines to a string to have it optimally fit into the horizontal
bounds set by the Text object's wordWrapWidth property.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">text</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
