Class: TextStyle

PIXI. TextStyle

A TextStyle Object decorates a Text Object. It can be shared between
multiple Text objects. Changing the style will update all text objects using it.

new PIXI.TextStyle(style)

Name Type Description
style object optional

The style parameters

Name Type Default Description
align string 'left' optional

Alignment for multiline text ('left', 'center' or 'right'),
does not affect single line text

breakWords boolean false optional

Indicates if lines can be wrapped within words, it
needs wordWrap to be set to true

dropShadow boolean false optional

Set a drop shadow for the text

dropShadowAngle number Math.PI/6 optional

Set a angle of the drop shadow

dropShadowBlur number 0 optional

Set a shadow blur radius

dropShadowColor string '#000000' optional

A fill style to be used on the dropshadow e.g 'red', '#00FF00'

dropShadowDistance number 5 optional

Set a distance of the drop shadow

fill string | Array.<string> | number | Array.<number> | CanvasGradient | CanvasPattern 'black' optional

A canvas
fillstyle that will be used on the text e.g 'red', '#00FF00'. Can be an array to create a gradient
eg ['#000000','#FFFFFF']
MDN

fillGradientType number PIXI.TEXT_GRADIENT.LINEAR_VERTICAL optional

If fills styles are
supplied, this can change the type/direction of the gradient. See PIXI.TEXT_GRADIENT for possible values

fontFamily string | Array.<string> 'Arial' optional

The font family

fontSize number | string 26 optional

The font size (as a number it converts to px, but as a string,
equivalents are '26px','20pt','160%' or '1.6em')

fontStyle string 'normal' optional

The font style ('normal', 'italic' or 'oblique')

fontVariant string 'normal' optional

The font variant ('normal' or 'small-caps')

fontWeight string 'normal' optional

The font weight ('normal', 'bold', 'bolder', 'lighter' and '100',
'200', '300', '400', '500', '600', '700', 800' or '900')

letterSpacing number 0 optional

The amount of spacing between letters, default is 0

lineHeight number optional

The line height, a number that represents the vertical space that a letter uses

lineJoin string 'miter' optional

The lineJoin property sets the type of corner created, it can resolve
spiked text issues. Default is 'miter' (creates a sharp corner).

miterLimit number 10 optional

The miter limit to use when using the 'miter' lineJoin mode. This can reduce
or increase the spikiness of rendered text.

padding number 0 optional

Occasionally some fonts are cropped. Adding some padding will prevent this from
happening by adding padding to all sides of the text.

stroke string | number 'black' optional

A canvas fillstyle that will be used on the text stroke
e.g 'blue', '#FCFF00'

strokeThickness number 0 optional

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

textBaseline string 'alphabetic' optional

The baseline of the text that is rendered.

wordWrap boolean false optional

Indicates if word wrap should be used

wordWrapWidth number 100 optional

The width at which text will wrap, it needs wordWrap to be set to true

Members

font

Set all properties of a font as a single string

Deprecated
  • since version 4.0.0

    Methods

    Creates a new TextStyle object with the same values as this one.
    Note that the only the properties of the object are cloned.

    Returns:
    Type Description
    PIXI.TextStyle New cloned TextStyle object

    Resets all properties to the defaults specified in TextStyle.prototype._default