PixiJS

Class: HTMLTextStyle

HTMLTextStyle

A TextStyle object rendered by the HTMLTextSystem.

Extends

Methods

addOverride (…value) void

ts:98

Add a style override, this can be any CSS property it will override any built-in style. This is the property and the value as a string (e.g., color: red). This will override any other internal style.

Name Type Description
value string

CSS style(s) to add.
Example
style.addOverride('background-color: red');

removeOverride (…value) void

ts:118

Remove any overrides that match the value.

Name Type Description
value string

CSS style to remove.
Example
style.removeOverride('background-color: red');

Inherited Properties

From class TextStyle

_fill ConvertedFillStyle inherited

_stroke ConvertedStrokeStyle inherited

align 'left' | 'center' | 'right' | 'justify' inherited overrides

See TextStyle.align

Default Value:
  • "left"

breakWords boolean inherited overrides

See TextStyle.breakWords

Default Value:
  • false

dropShadow inherited overrides

See TextStyle.dropShadow

Default Value:
  • undefined

fill string | Array<string> | number | Array<number> | CanvasGradient | CanvasPattern inherited overrides

See TextStyle.fill

Default Value:
  • "black"

fontFamily string | Array<string> inherited overrides

See TextStyle.fontFamily

Default Value:
  • "Arial"

fontSize number | string inherited overrides

See TextStyle.fontSize

Default Value:
  • 26

fontStyle 'normal' | 'italic' | 'oblique' inherited overrides

See TextStyle.fontStyle

Default Value:
  • "normal"

fontVariant 'normal' | 'small-caps' inherited overrides

See TextStyle.fontVariant

Default Value:
  • "normal"

fontWeight 'normal' | 'bold' | 'bolder' | 'lighter' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900' inherited overrides

See TextStyle.fontWeight

Default Value:
  • "normal"

leading number inherited overrides

See TextStyle.leading

Default Value:
  • 0

letterSpacing number inherited overrides

See TextStyle.letterSpacing

Default Value:
  • 0

lineHeight number inherited overrides

See TextStyle.lineHeight

Default Value:
  • 0

padding number inherited overrides

See TextStyle.padding

Default Value:
  • 0

stroke string | number inherited overrides

See TextStyle.stroke

Default Value:
  • undefined

textBaseline 'alphabetic' | 'top' | 'hanging' | 'middle' | 'ideographic' | 'bottom' inherited overrides

See TextStyle.textBaseline

Default Value:
  • "alphabetic"

trim boolean inherited overrides

See TextStyle.trim

Default Value:
  • false

whiteSpace 'normal' | 'pre' | 'pre-line' inherited overrides

See TextStyle.whiteSpace

Default Value:
  • "pre"

wordWrap boolean inherited overrides

See TextStyle.wordWrap

Default Value:
  • false

wordWrapWidth number inherited overrides

See TextStyle.wordWrapWidth

Default Value:
  • 100

Inherited Methods

From class TextStyle

clone () TextStyle inherited

ts:442

Creates a new TextStyle object with the same values as this one.

Returns:
Type Description
TextStyle New cloned TextStyle object

destroy (options) inherited

ts:470

Destroys this text style.

Name Type Attributes Default Description
options TypeOrBool<TextureDestroyOptions> false

Options parameter. A boolean will act as if all options have been set to that value
options.texture boolean <optional>
 false

Should it destroy the texture of the this style
options.textureSource boolean <optional>
 false

Should it destroy the textureSource of the this style