Class: Text

Extends

• Sprite

Members

---

_composite :String

The composite operation type. Can be source-atop|source-in|source-out|source-over|destination-atop|destination-in|destination-out|destination-over|lighter|xor|copy
Default is 'source-over'

Type:

• String

Inherited From:

• Sprite#_composite

Source:

• Sprite.js, line 20

Methods

---

getBoundingArea()

Inherited From:

• Sprite#getBoundingArea

Source:

• Sprite.js, line 42

Returns:

The bounding area

Type

Object

---

getComposite()

Inherited From:

• Sprite#getComposite

Source:

• Sprite.js, line 51

Returns:

Type

String

---

getHeight()

Inherited From:

• Sprite#getHeight

Source:

• Sprite.js, line 59

Returns:

Type

Integer

---

getOpacity()

Inherited From:

• Sprite#getOpacity

Source:

• Sprite.js, line 67

Returns:

Type

Float

---

getPivotX()

Inherited From:

• Sprite#getPivotX

Source:

• Sprite.js, line 75

Returns:

Type

Integer

---

getPivotY()

Inherited From:

• Sprite#getPivotY

Source:

• Sprite.js, line 83

Returns:

Type

Integer

---

getRotation()

Inherited From:

• Sprite#getRotation

Overrides:

• Sprite#getRotation

Source:

• Sprite.js, line 91

Returns:

Type

Float

---

getScaleX()

Inherited From:

• Sprite#getScaleX

Source:

• Sprite.js, line 107

Returns:

Type

Integer

---

getScaleY()

Inherited From:

• Sprite#getScaleY

Source:

• Sprite.js, line 115

Returns:

Type

Integer

---

getSrcHeight()

Inherited From:

• Sprite#getSrcHeight

Source:

• Sprite.js, line 123

Returns:

Type

Integer

---

getSrcWidth()

Inherited From:

• Sprite#getSrcWidth

Source:

• Sprite.js, line 131

Returns:

Type

Integer

---

getSrcX()

Inherited From:

• Sprite#getSrcX

Source:

• Sprite.js, line 139

Returns:

Type

Integer

---

getSrcY()

Inherited From:

• Sprite#getSrcY

Source:

• Sprite.js, line 147

Returns:

Type

Integer

---

getValue()

Returns current text value

Source:

• text/Text.js, line 22

Returns:

Type

String

---

getWidth()

Inherited From:

• Sprite#getWidth

Source:

• Sprite.js, line 155

Returns:

Type

Integer

---

getX()

Inherited From:

• Sprite#getX

Source:

• Sprite.js, line 163

Returns:

Type

Integer

---

getY()

Inherited From:

• Sprite#getY

Source:

• Sprite.js, line 171

Returns:

Type

Integer

---

render(context, factor, ticks)

Parameters:

Name	Type	Description
context	Object	The CanvasRenderingContext2D object
factor	Integer	The 0-1-based model of elapsed time
ticks	Integer	Total elapsed ticks

Overrides:

• Sprite#render

Source:

• text/Text.js, line 69

---

setComposite(val)

Parameters:

Name	Type	Description
val	Integer	The composite value

Inherited From:

• Sprite#setComposite

Overrides:

• Sprite#setComposite

Source:

• Sprite.js, line 197

Returns:

Type

Sprite

---

setFill(val)

[setFill description]

Parameters:

Name	Type	Description
val	String	The fill color hex, rgb, rgba, etc.

Source:

• text/Text.js, line 37

---

setHeight(val)

Parameters:

Name	Type	Description
val	Integer	The height value

Inherited From:

• Sprite#setHeight

Source:

• Sprite.js, line 209

Returns:

Type

Sprite

---

setOpacity(val)

Parameters:

Name	Type	Description
val	Float	The opacity value

Inherited From:

• Sprite#setOpacity

Source:

• Sprite.js, line 221

Returns:

Type

Sprite

---

setPivotX(val)

Parameters:

Name	Type	Description
val	Float	The opacity value

Inherited From:

• Sprite#setPivotX

Source:

• Sprite.js, line 233

Returns:

Type

Sprite

---

setPivotY(val)

Parameters:

Name	Type	Description
val	Float	The opacity value

Inherited From:

• Sprite#setPivotY

Source:

• Sprite.js, line 244

Returns:

Type

Sprite

---

setRotation(val)

Parameters:

Name	Type	Description
val	Integer	The rotation value

Inherited From:

• Sprite#setRotation

Source:

• Sprite.js, line 255

Returns:

Type

Sprite

---

setScaleX(val)

Parameters:

Name	Type	Description
val	Integer	The scaleX value

Inherited From:

• Sprite#setScaleX

Source:

• Sprite.js, line 267

Returns:

Type

Sprite

---

setScaleY(val)

Parameters:

Name	Type	Description
val	Integer	The scaleY value

Inherited From:

• Sprite#setScaleY

Source:

• Sprite.js, line 279

Returns:

Type

Sprite

---

setSrcHeight(val)

Parameters:

Name	Type	Description
val	Integer	The srcHeight value

Inherited From:

• Sprite#setSrcHeight

Source:

• Sprite.js, line 291

Returns:

Type

Sprite

---

setSrcWidth(val)

Parameters:

Name	Type	Description
val	Integer	The srcWidth value

Inherited From:

• Sprite#setSrcWidth

Source:

• Sprite.js, line 303

Returns:

Type

Sprite

---

setSrcX(val)

Parameters:

Name	Type	Description
val	Integer	The srcX value

Inherited From:

• Sprite#setSrcX

Source:

• Sprite.js, line 315

Returns:

Type

Sprite

---

setSrcY(val)

Parameters:

Name	Type	Description
val	Integer	The srcY value

Inherited From:

• Sprite#setSrcY

Source:

• Sprite.js, line 327

Returns:

Type

Sprite

---

setStroke(val)

[setStroke description]

Parameters:

Name	Type	Description
val	String	The stroke color hex, rgb, rgba, etc.

Source:

• text/Text.js, line 48

---

setValue(val)

Parameters:

Name	Type	Description
val	String	The desired string value

Source:

• text/Text.js, line 59

---

setWidth(val)

Parameters:

Name	Type	Description
val	Integer	The width value

Inherited From:

• Sprite#setWidth

Source:

• Sprite.js, line 339

Returns:

Type

Sprite

---

setY(val)

Parameters:

Name	Type	Description
val	Integer	The y value

Inherited From:

• Sprite#setY

Source:

• Sprite.js, line 363

Returns:

Type

Sprite

---

translate(x, y)

Add/Subtract current x/y values. Assign any non-number to leave value the same.

Parameters:

Name	Type	Argument	Description
x	Integer	<optional>
y	Integer	<optional>

Inherited From:

• Sprite#translate

Source:

• Sprite.js, line 375

Returns:

Type

Sprite