PIXI

Class: Text

PIXI. Text

A Text Object will create a line or multiple lines of text. To split a line you can use '\n' in your text string,
or add a wordWrap property set to true and and wordWrapWidth property with a value in the style object.

A Text can be created directly from a string and a style object

let text = new PIXI.Text('This is a pixi text',{fontFamily : 'Arial', fontSize: 24, fill : 0xff1010, align : 'center'});

new PIXI.Text(text, style)

core/text/Text.js, line 31
Name Type Description
text string

The string that you would like the text to display
style object | PIXI.TextStyle optional

The style parameters

Extends

Members

anchor

Copies the anchor to the sprite.

cacheAsBitmapboolean

Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'

filters

Shallow copies the array to the filters of the object.

height

Sets the height of the text.

mask

Sets the mask.

pivot

Copies the point to the pivot of the object.

position

Copies the point to the position of the object.

rotation

Sets the rotation of the object.

scale

Copies the point to the scale of the object.

skew

Copies the point to the skew of the object.

style

Sets the style of the text.

text

Sets the text.

texture

Sets the texture of the sprite.

tint

Sets the tint of the sprite.

width

Sets the width of the text.

x

Sets the X position of the object.

y

Sets the Y position of the object.

Methods

_calculateBounds()

core/text/Text.js, line 587

calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

inherited _recursivePostUpdateTransform()

core/display/DisplayObject.js, line 151

recursively updates transform of all objects from the root to this one
internal function for toLocal()

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 55

Adds a child or multiple children to the container.

Multple items can be added like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject repeatable

The DisplayObject(s) to add to the container
Returns:
Type Description
PIXI.DisplayObject The first child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 90

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name Type Description
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited calculateBounds()

core/display/Container.js, line 303

Recalculates the bounds of the container.

inherited calculateTrimmedVertices()

core/sprites/Sprite.js, line 231

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

inherited calculateVertices()

core/sprites/Sprite.js, line 161

calculates worldTransform * vertices, store it in vertexData

inherited containsPoint(point){boolean}

core/sprites/Sprite.js, line 365

Tests if a point is inside this sprite

Name Type Description
point PIXI.Point

the point to test
Returns:
Type Description
boolean the result of the test

destroy(options)

core/text/Text.js, line 688

Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as
the majorety of the time the texture will not be shared with any other Sprites.

Name Type Description
options object | boolean optional

Options parameter. A boolean will act as if all options
have been set to that value

Name Type Default Description
children boolean false optional

if set to true, all the children will have their
destroy method called as well. 'options' will be passed on to those calls.
texture boolean true optional

Should it destroy the current texture of the sprite as well
baseTexture boolean true optional

Should it destroy the base texture of the sprite as well

inherited getBounds(skipUpdate, rect){PIXI.Rectangle}

core/display/DisplayObject.js, line 173

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate boolean

setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost
rect PIXI.Rectangle

Optional rectangle to store the result of the bounds calculation
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 178

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 140

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

inherited getLocalBounds(rect){Rectangle}

core/sprites/Sprite.js, line 333

Gets the local bounds of the sprite object.

Name Type Description
rect Rectangle

The output rectangle.
Returns:
Type Description
Rectangle The bounds.

inherited removeChild(childs){PIXI.DisplayObject}

core/display/Container.js, line 194

Removes a child from the container.

Name Type Description
childs PIXI.DisplayObject repeatable

The DisplayObject(s) to remove
Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 220

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}

core/display/Container.js, line 241

Removes all children from this container that are within the begin and end indexes.

Name Type Default Description
beginIndex number 0 optional

The beginning position.
endIndex number this.children.length optional

The ending position. Default value is size of the container.
Returns:
Type Description
Array.<DisplayObject> List of removed children

inherited renderCanvas(renderer)

core/display/Container.js, line 474

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

renderWebGL(renderer)

core/text/Text.js, line 366

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 158

Changes the position of an existing child in the display object container

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

inherited setParent(container){PIXI.Container}

core/display/DisplayObject.js, line 340

Set the parent Container of this DisplayObject

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to
Returns:
Type Description
PIXI.Container The Container that this DisplayObject was added to

setStyle(style)

deprecation.js, line 440
Name Type Description
style *

The style to set to.
Deprecated
  • since version 3.0.0
    See:

    setText(text)

    deprecation.js, line 427
    Name Type Description
    text string

    The text to set to.
    Deprecated
    • since version 3.0.0
      See:

      inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

      core/display/DisplayObject.js, line 366

      Convenience function to set the postion, scale, skew and pivot at once.

      Name Type Default Description
      x number 0 optional

      The X position
      y number 0 optional

      The Y position
      scaleX number 1 optional

      The X scale value
      scaleY number 1 optional

      The Y scale value
      rotation number 0 optional

      The rotation
      skewX number 0 optional

      The X skew value
      skewY number 0 optional

      The Y skew value
      pivotX number 0 optional

      The X pivot value
      pivotY number 0 optional

      The Y pivot value
      Returns:
      Type Description
      PIXI.DisplayObject The DisplayObject instance

      inherited swapChildren(child, child2)

      core/display/Container.js, line 119

      Swaps the position of 2 Display Objects within this container.

      Name Type Description
      child PIXI.DisplayObject

      First display object to swap
      child2 PIXI.DisplayObject

      Second display object to swap

      inherited toGlobal(position, point, skipUpdate){PIXI.Point}

      core/display/DisplayObject.js, line 249

      Calculates the global position of the display object

      Name Type Default Description
      position PIXI.Point

      The world origin to calculate from
      point PIXI.Point optional

      A Point object in which to store the value, optional
      (otherwise will create a new Point)
      skipUpdate boolean false optional

      Should we skip the update transform.
      Returns:
      Type Description
      PIXI.Point A point object representing the position of this object

      inherited toLocal(position, from, point, skipUpdate){PIXI.Point}

      core/display/DisplayObject.js, line 284

      Calculates the local position of the display object relative to another point

      Name Type Default Description
      position PIXI.Point

      The world origin to calculate from
      from PIXI.DisplayObject optional

      The DisplayObject to calculate the global position from
      point PIXI.Point optional

      A Point object in which to store the value, optional
      (otherwise will create a new Point)
      skipUpdate boolean false optional

      Should we skip the update transform
      Returns:
      Type Description
      PIXI.Point A point object representing the position of this object