API Docs for: 1.3.0
Show:

Text Class

Extends Sprite
Defined in: src/pixi/text/Text.js:5
Module: PIXI

A Text Object will create a line(s) of text to split a line you can use "\n"

Constructor

Text

(
  • text
  • [style]
)

Defined in src/pixi/text/Text.js:5

Parameters:

  • text String

    The copy that you would like the text to display

  • [style] Object optional

    The style parameters

    • [font] String optional

      default "bold 20pt Arial" The style and size of the font

    • [fill="black"] Object optional

      A canvas fillstyle that will be used on the text eg "red", "#00FF00"

    • [align="left"] String optional

      An alignment of the multiline text ("left", "center" or "right")

    • [stroke] String optional

      A canvas fillstyle that will be used on the text stroke eg "blue", "#FCFF00"

    • [strokeThickness=0] Number optional

      A number that represents the thickness of the stroke. Default is 0 (no stroke)

    • [wordWrap=false] Boolean optional

      Indicates if word wrap should be used

    • [wordWrapWidth=100] Number optional

      The width at which text will wrap

Methods

addChild

(
  • DisplayObject
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:41

Adds a child to the container.

Parameters:

addChildAt

(
  • DisplayObject
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:73

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

Parameters:

click

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:106

A callback that is used when the users clicks on the displayObject with their mouse

Parameters:

getChildAt

(
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:168

Returns the Child at the specified index

Parameters:

  • index Number

mousedown

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:112

A callback that is used when the user clicks the mouse down over the sprite

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:138

A callback that is used when the users mouse leaves the displayObject

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:132

A callback that is used when the users mouse rolls over the displayObject

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:118

A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject

Parameters:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:125

A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject

Parameters:

removeChild

(
  • DisplayObject
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:186

Removes a child from the container.

Parameters:

setInteractive

(
  • interactive
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:190

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Parameters:

  • interactive Boolean

setStyle

(
  • [style]
  • [style.font="bold
)

Defined in src/pixi/text/Text.js:37

Set the style of the text

Parameters:

  • [style] Object optional

    The style parameters

    • [fill="black"] Object optional

      A canvas fillstyle that will be used on the text eg "red", "#00FF00"

    • [align="left"] String optional

      An alignment of the multiline text ("left", "center" or "right")

    • [stroke="black"] String optional

      A canvas fillstyle that will be used on the text stroke eg "blue", "#FCFF00"

    • [strokeThickness=0] Number optional

      A number that represents the thickness of the stroke. Default is 0 (no stroke)

    • [wordWrap=false] Boolean optional

      Indicates if word wrap should be used

    • [wordWrapWidth=100] Number optional

      The width at which text will wrap

  • [style.font="bold String

    20pt Arial"] The style and size of the font

setTexture

(
  • texture
)

Inherited from Sprite: src/pixi/display/Sprite.js:103

Parameters:

  • texture Texture

    The PIXI texture that is displayed by the sprite

swapChildren

(
  • DisplayObject
  • DisplayObject2
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:128

Swaps the depth of 2 displayObjects

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:149

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

touchend

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:162

A callback that is used when the user releases a touch over the displayObject

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:168

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Parameters:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:156

A callback that is used when the user touch's over the displayObject

Parameters:

Properties

alpha

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:40

The opacity of the object.

anchor

Point

Inherited from Sprite: src/pixi/display/Sprite.js:21

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

blendMode

Uint

Inherited from Sprite: src/pixi/display/Sprite.js:38

The blend mode of sprite. currently supports PIXI.blendModes.NORMAL and PIXI.blendModes.SCREEN

buttonMode

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:95

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

children

Array

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:16

[read-only] The of children of this container.

height

#Number

Inherited from Sprite: src/pixi/display/Sprite.js:53

The height of the sprite (this is initially set by the texture)

hitArea

Rectangle

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:69

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

parent

DisplayObjectContainer

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:55

[read-only] The display object container that contains this display object.

pivot

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:26

The pivot point of the displayObject that it rotates around

position

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:12

The coordinate of the object relative to the local coordinates of the parent.

rotation

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:33

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:19

The scale factor of the object.

stage

Stage

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:62

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

texture

Texture

Inherited from Sprite: src/pixi/display/Sprite.js:31

The texture that the sprite is using

visible

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:47

The visibility of the object.

width

#Number

Inherited from Sprite: src/pixi/display/Sprite.js:46

The width of the sprite (this is initially set by the texture)