API Docs for: 1.4.0
Show:

BitmapText Class

A Text Object will create a line(s) of text using bitmap font. To split a line you can use '\n', '\r' or '\r\n' You can generate the fnt files using http://www.angelcode.com/products/bmfont/ for windows or http://www.bmglyph.com/ for mac.

Constructor

BitmapText

(
  • text
  • style
)

Parameters:

  • text String

    The copy that you would like the text to display

  • style Object

    The style parameters

    • font String

      The size (optional) and bitmap font id (required) eq 'Arial' or '20px Arial' (must have loaded previously)

    • [align='left'] String optional

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

Methods

addChild

(
  • child
)

Adds a child to the container.

Parameters:

addChildAt

(
  • child
  • index
)

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

Parameters:

  • child DisplayObject

    The child to add

  • index Number

    The index to place the child in

click

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

getChildAt

(
  • index
)

Returns the Child at the specified index

Parameters:

  • index Number

    The index to get the child from

mousedown

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

mouseout

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

mouseover

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

mouseup

(
  • interactionData
)

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:

  • interactionData InteractionData

mouseupoutside

(
  • interactionData
)

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:

  • interactionData InteractionData

removeChild

(
  • child
)

Removes a child from the container.

Parameters:

setInteractive

(
  • interactive
)
deprecated

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

Deprecated: Simply set the `interactive` property directly

[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false

Parameters:

  • interactive Boolean

setStyle

(
  • style
)

Set the style of the text

Parameters:

  • style Object

    The style parameters

    • font String

      The size (optional) and bitmap font id (required) eq 'Arial' or '20px Arial' (must have loaded previously)

    • [align='left'] String optional

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

setText

(
  • text
)

Set the copy for the text object

Parameters:

  • text String

    The copy that you would like the text to display

swapChildren

(
  • child
  • child2
)
private

[NYI] Swaps the depth of 2 displayObjects

Parameters:

tap

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

touchend

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

touchendoutside

(
  • interactionData
)

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:

  • interactionData InteractionData

touchstart

(
  • interactionData
)

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

Parameters:

  • interactionData InteractionData

updateText

() private

Renders text

updateTransform

() private

Updates the transfor of this object

Properties

_interactive

Boolean private

[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property

alpha

Number

The opacity of the object.

buttonMode

Boolean

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

children

Array

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

color

Array<> private

[NYI] Unkown

defaultCursor

String

This is the curser that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

dynamic

Boolean private

[NYI] Holds whether or not this object is dynamic, for rendering optimization

filters

Array An array of filters

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'

height

Number

The height of the displayObjectContainer, setting this will actually modify the scale to acheive the value set

hitArea

Rectangle | Circle | Ellipse | Polygon

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)

interactive

Boolean

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

Default: false

localTransform

Mat3 private

[read-only] Current transform of the object locally

mask

Graphics

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.Ggraphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

parent

DisplayObjectContainer

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

pivot

Point

The pivot point of the displayObject that it rotates around

position

Point

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

renderable

Boolean

Can this object be rendered

rotation

Number

The rotation of the object in radians.

scale

Point

The scale factor of the object.

stage

Stage

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

visible

Boolean

The visibility of the object.

width

Number

The width of the displayObjectContainer, setting this will actually modify the scale to acheive the value set

worldAlpha

Number

[read-only] The multiplied alpha of the displayobject

worldTransform

Mat3 private

[read-only] Current transform of the object based on world (parent) factors

worldVisible

Boolean

[read-only] Indicates if the sprite is globaly visible.