Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text
Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text
Indicates if lines can be wrapped within words, it needs wordWrap to be set to true
Indicates if lines can be wrapped within words, it needs wordWrap to be set to true
Set a drop shadow for the text
Set a drop shadow for the text
Set alpha for the drop shadow
Set alpha for the drop shadow
Set a angle of the drop shadow
Set a angle of the drop shadow
Set a shadow blur radius
Set a shadow blur radius
A fill style to be used on the dropshadow e.g 'red', '#00FF00'
A fill style to be used on the dropshadow e.g 'red', '#00FF00'
Set a distance of the drop shadow
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 eg ['#000000','#FFFFFF'] MDN
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
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.
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.
If fill is an array of colours to create a gradient, this can change the type/direction of the gradient. See 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
The font family
The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')
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 ('normal', 'italic' or 'oblique')
The font style ('normal', 'italic' or 'oblique')
The font variant ('normal' or 'small-caps')
The font variant ('normal' or 'small-caps')
The font weight ('normal', 'bold', 'bolder', 'lighter' and '100', '200', '300', '400', '500', '600', '700', 800' or '900')
The font weight ('normal', 'bold', 'bolder', 'lighter' and '100', '200', '300', '400', '500', '600', '700', 800' or '900')
The space between lines
The space between lines
The amount of spacing between letters, default is 0
The amount of spacing between letters, default is 0
The line height, a number that represents the vertical space that a letter uses
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. Default is 'miter' (creates a sharp corner).
The lineJoin property sets the type of corner created, it can resolve spiked text issues. Default is 'miter' (creates a sharp corner).
The miter limit to use when using the 'miter' lineJoin mode This can reduce or increase the spikiness of rendered text.
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.
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 canvas fillstyle that will be used on the text stroke e.g 'blue', '#FCFF00'
A number that represents the thickness of the stroke. Default is 0 (no stroke)
A number that represents the thickness of the stroke. Default is 0 (no stroke)
The baseline of the text that is rendered.
The baseline of the text that is rendered.
Trim transparent borders
Trim transparent borders
How newlines and spaces should be handled. Default is 'pre' (preserve, preserve).
| value | New lines | Spaces |
|---|---|---|
| 'normal' | Collapse | Collapse |
| 'pre' | Preserve | Preserve |
| 'pre-line' | Preserve | Collapse |
How newlines and spaces should be handled. Default is 'pre' (preserve, preserve).
| value | New lines | Spaces |
|---|---|---|
| 'normal' | Collapse | Collapse |
| 'pre' | Preserve | Preserve |
| 'pre-line' | Preserve | Collapse |
Indicates if word wrap should be used
Indicates if word wrap should be used
The width at which text will wrap, it needs wordWrap to be set to true
The width at which text will wrap, it needs wordWrap to be set to true
Creates a new TextStyle object with the same values as this one. Note that the only the properties of the object are cloned.
New cloned TextStyle object
Resets all properties to the defaults specified in TextStyle.prototype._default
Generates a font style string to use for TextMetrics.measureFont().
Font style string, for passing to TextMetrics.measureFont()
Generated using TypeDoc
A TextStyle Object contains information to decorate a Text objects.
An instance can be shared between multiple Text objects; then changing the style will update all text objects using it.
A tool can be used to generate a text style here.
PIXI