PixiJS

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 PixiJS text',{fontFamily : 'Arial', fontSize: 24, fill : 0xff1010, align : 'center'});

new PIXI.Text(text, style, canvas)

Text.js:34
Name Type Description
text string

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

The style parameters
canvas HTMLCanvasElement optional

The canvas element for drawing text

Extends

Members

staticPIXI.Text.calculateFontProperties

Calculates the ascent, descent and fontSize of a given fontStyle

Deprecated
  • since version 4.5.0
    See:

    alphanumber

    The opacity of the object.

    anchorPIXI.ObservablePoint

    The anchor sets the origin point of the texture. The default is 0,0 this means the texture's origin is the top left Setting the anchor to 0.5,0.5 means the texture's origin is centered Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

    blendModenumber

    The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

    Default Value:
    • PIXI.BLEND_MODES.NORMAL
    See:

    buttonModeboolean

    If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

    Example
    const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

    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'

    IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

    canvasHTMLCanvasElement

    The canvas element that everything is drawn to

    readonlychildrenArray.<PIXI.DisplayObject>

    The array of children of this container.

    contextCanvasRenderingContext2D

    The canvas 2d context that everything is drawn with

    cursorstring

    This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

    See:
    Example
    const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

    filterAreaPIXI.Rectangle

    The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

    Also works as an interaction mask

    filtersArray.<PIXI.Filter>

    Sets the filters for the displayObject.

    • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'

    heightnumber

    The height of the Text, setting this will actually modify the scale to achieve the value set

    hitAreaPIXI.Rectangle PIXI.Circle PIXI.Ellipse PIXI.Polygon PIXI.RoundedRectangle

    Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

    Example
    const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

    interactiveboolean

    Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

    Example
    const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

    interactiveChildrenboolean

    Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

    readonlylocalTransformPIXI.Matrix

    Current transform of the object based on local factors: position, scale, other stuff

    maskPIXI.Graphics PIXI.Sprite

    Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

    TODO
    • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

    readonlyparentPIXI.Container

    The display object container that contains this display object.

    pivotPIXI.Point PIXI.ObservablePoint

    The pivot point of the displayObject that it rotates around Assignment by value since pixi-v4.

    pluginNamestring

    Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.

    Default Value:
    • 'sprite'

    positionPIXI.Point PIXI.ObservablePoint

    The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

    renderableboolean

    Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

    Only affects recursive calls from parent. You can ask for bounds manually

    resolutionnumber

    The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.

    Default Value:
    • 1

    rotationnumber

    The rotation of the object in radians.

    scalePIXI.Point PIXI.ObservablePoint

    The scale factor of the object. Assignment by value since pixi-v4.

    shaderPIXI.Filter PIXI.Shader

    The shader that will be used to render the sprite. Set to null to remove a current shader.

    skewPIXI.ObservablePoint

    The skew factor for the object in radians. Assignment by value since pixi-v4.

    styleobject PIXI.TextStyle

    Set the style of the text. Set up an event listener to listen for changes on the style object and mark the text as dirty.

    textstring

    Set the copy for the text object. To split a line you can use '\n'.

    texturePIXI.Texture

    The texture that the sprite is using

    tintnumber

    The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

    Default Value:
    • 0xFFFFFF

    transformPIXI.TransformBase

    World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing

    visibleboolean

    The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

    Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

    widthnumber

    The width of the Text, setting this will actually modify the scale to achieve the value set

    readonlyworldAlphanumber

    The multiplied alpha of the displayObject

    readonlyworldTransformPIXI.Matrix

    Current transform of the object based on world (parent) factors

    readonlyworldVisibleboolean

    Indicates if the object is globally visible.

    xnumber

    The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

    ynumber

    The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

    Methods

    staticPIXI.Text.getFontStyle(style)string

    deprecation.js:753
    Name Type Description
    style PIXI.TextStyle

    The style to use.
    Deprecated
    • since version 4.5.0
      See:
      • PIXI.TextMetrics.getFontStyle
      Returns:
      Type Description
      string Font string

      _calculateBounds()

      Text.js:410

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

      inherited _recursivePostUpdateTransform()

      DisplayObject.js:174

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

      inherited addChild(child)PIXI.DisplayObject

      Container.js:55

      Adds one or more children to the container.

      Multiple items can be added like so: myContainer.addChild(thingOne, 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

      Container.js:101

      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()

      Container.js:345

      Recalculates the bounds of the container.

      inherited calculateTrimmedVertices()

      Sprite.js:246

      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()

      Sprite.js:176

      calculates worldTransform * vertices, store it in vertexData

      inherited containsPoint(point)boolean

      Sprite.js:387

      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)

      Text.js:548

      Destroys this text object. Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as the majority 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

      DisplayObject.js:196

      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

      Container.js:195

      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

      Container.js:156

      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

      getLocalBounds(rect)Rectangle

      Text.js:400

      Gets the local bounds of the text object.

      Name Type Description
      rect Rectangle

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

      inherited removeChild(child)PIXI.DisplayObject

      Container.js:211

      Removes one or more children from the container.

      Name Type Description
      child PIXI.DisplayObject repeatable

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

      inherited removeChildAt(index)PIXI.DisplayObject

      Container.js:253

      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>

      Container.js:279

      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)

      Container.js:512

      Renders the object using the Canvas renderer

      Name Type Description
      renderer PIXI.CanvasRenderer

      The renderer

      renderWebGL(renderer)

      Text.js:362

      Renders the object using the WebGL renderer

      Name Type Description
      renderer PIXI.WebGLRenderer

      The renderer

      inherited setChildIndex(child, index)

      Container.js:174

      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

      DisplayObject.js:363

      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:724
      Name Type Description
      style *

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

        setText(text)

        deprecation.js:668
        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

          DisplayObject.js:389

          Convenience function to set the position, 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)

          Container.js:135

          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

          DisplayObject.js:272

          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

          DisplayObject.js:307

          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

          inherited updateTransform()

          Container.js:321

          Updates the transform on all children of this container for rendering

          Events

          inherited added

          DisplayObject.js:127

          Fired when this DisplayObject is added to a Container.

          Name Type Description
          container PIXI.Container

          The container added to.

          inherited click

          InteractionManager.js:476

          Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mousedown

          InteractionManager.js:444

          Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mousemove

          InteractionManager.js:512

          Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mouseout

          InteractionManager.js:528

          Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mouseover

          InteractionManager.js:520

          Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mouseup

          InteractionManager.js:460

          Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited mouseupoutside

          InteractionManager.js:492

          Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointercancel

          InteractionManager.js:552

          Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointerdown

          InteractionManager.js:536

          Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointermove

          InteractionManager.js:577

          Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointerout

          InteractionManager.js:593

          Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointerover

          InteractionManager.js:585

          Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointertap

          InteractionManager.js:560

          Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointerup

          InteractionManager.js:544

          Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited pointerupoutside

          InteractionManager.js:568

          Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited removed

          DisplayObject.js:134

          Fired when this DisplayObject is removed from a Container.

          Name Type Description
          container PIXI.Container

          The container removed from.

          inherited rightclick

          InteractionManager.js:484

          Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited rightdown

          InteractionManager.js:452

          Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited rightup

          InteractionManager.js:468

          Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited rightupoutside

          InteractionManager.js:502

          Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited tap

          InteractionManager.js:625

          Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited touchcancel

          InteractionManager.js:617

          Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited touchend

          InteractionManager.js:609

          Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited touchendoutside

          InteractionManager.js:633

          Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited touchmove

          InteractionManager.js:642

          Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event

          inherited touchstart

          InteractionManager.js:601

          Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

          Name Type Description
          event PIXI.interaction.InteractionEvent

          Interaction event