Properties:
| Name | Type | Description |
|---|---|---|
align |
'left' | 'center' | 'right' | 'justify' |
Alignment for multiline text, does not affect single line text |
breakWords |
boolean |
Indicates if lines can be wrapped within words, it needs wordWrap to be set to true |
dropShadow |
boolean |
Set a drop shadow for the text |
dropShadowAlpha |
number |
Set alpha for the drop shadow |
dropShadowAngle |
number |
Set a angle of the drop shadow |
dropShadowBlur |
number |
Set a shadow blur radius |
dropShadowColor |
string | number |
A fill style to be used on the dropshadow e.g., 'red', '#00FF00' |
dropShadowDistance |
number |
Set a distance of the drop shadow |
fill |
string | Array<string> | number | Array<number> | CanvasGradient | CanvasPattern |
A canvas fillstyle that will be used on the text e.g., 'red', '#00FF00'.
Can be an array to create a gradient, e.g., |
fillGradientStops |
number[] |
If fill is an array of colours to create a gradient, this array can set the stop points (numbers between 0 and 1) for the color, overriding the default behaviour of evenly spacing them. |
fillGradientType |
PIXI.TEXT_GRADIENT |
If fill is an array of colours to create a gradient, this can change the type/direction of the gradient. See PIXI.TEXT_GRADIENT |
fontFamily |
string | string[] |
The font family, can be a single font name, or a list of names where the first is the preferred font. |
fontSize |
number | string |
The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em') |
fontStyle |
'normal' | 'italic' | 'oblique' |
The font style. |
fontVariant |
'normal' | 'small-caps' |
The font variant. |
fontWeight |
'normal' | 'bold' | 'bolder' | 'lighter' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900' |
The font weight. |
leading |
number |
The height of the line, a number that represents the vertical space that a letter uses. |
letterSpacing |
number |
The amount of spacing between letters, default is 0 |
lineHeight |
number |
The line height, a number that represents the vertical space that a letter uses |
lineJoin |
'miter' | 'round' | 'bevel' |
The lineJoin property sets the type of corner created, it can resolve spiked text issues. Possible values "miter" (creates a sharp corner), "round" (creates a round corner) or "bevel" (creates a squared corner). |
miterLimit |
number |
The miter limit to use when using the 'miter' lineJoin mode. This can reduce or increase the spikiness of rendered text. |
padding |
number |
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 |
A canvas fillstyle that will be used on the text stroke, e.g., 'blue', '#FCFF00' |
strokeThickness |
number |
A number that represents the thickness of the stroke. A value of 0 will disable stroke. |
textBaseline |
'alphabetic' | 'top' | 'hanging' | 'middle' | 'ideographic' | 'bottom' |
The baseline of the text that is rendered. |
trim |
boolean |
Trim transparent borders |
whiteSpace |
'normal' | 'pre' | 'pre-line' |
Determines whether newlines & spaces are collapsed or preserved "normal" (collapse, collapse), "pre" (preserve, preserve) | "pre-line" (preserve, collapse). It needs wordWrap to be set to true. |
wordWrap |
boolean |
Indicates if word wrap should be used |
wordWrapWidth |
number |
The width at which text will wrap, it needs wordWrap to be set to true |
Members
Alignment for multiline text, does not affect single line text
Indicates if lines can be wrapped within words, it needs wordWrap to be set to true
Set a drop shadow for the text
Set alpha for the drop shadow
Set a angle of the drop shadow
Set a shadow blur radius
A fill style to be used on the dropshadow e.g., 'red', '#00FF00'
Set a distance of the drop shadow
A canvas fillstyle that will be used on the text e.g., 'red', '#00FF00'.
Can be an array to create a gradient, e.g., ['#000000','#FFFFFF']
MDN
If fill is an array of colours to create a gradient, this array can set the stop points (numbers between 0 and 1) for the color, overriding the default behaviour of evenly spacing them.
fillGradientType PIXI.TEXT_GRADIENT
If fill is an array of colours to create a gradient, this can change the type/direction of the gradient. See PIXI.TEXT_GRADIENT
The font family, can be a single font name, or a list of names where the first is the preferred font.
The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')
The font style.
The font variant.
The font weight.
The height of the line, a number that represents the vertical space that a letter uses.
The amount of spacing between letters, default is 0
The line height, a number that represents the vertical space that a letter uses
The lineJoin property sets the type of corner created, it can resolve spiked text issues. Possible values "miter" (creates a sharp corner), "round" (creates a round corner) or "bevel" (creates a squared corner).
The miter limit to use when using the 'miter' lineJoin mode. This can reduce or increase the spikiness of rendered text.
Occasionally some fonts are cropped. Adding some padding will prevent this from happening by adding padding to all sides of the text.
A canvas fillstyle that will be used on the text stroke, e.g., 'blue', '#FCFF00'
A number that represents the thickness of the stroke. A value of 0 will disable stroke.
The baseline of the text that is rendered.
Trim transparent borders
Determines whether newlines & spaces are collapsed or preserved "normal" (collapse, collapse), "pre" (preserve, preserve) | "pre-line" (preserve, collapse). It needs wordWrap to be set to true.
Indicates if word wrap should be used
The width at which text will wrap, it needs wordWrap to be set to true