Font

Represents a system or web font in Excalibur

If no options specified, the system sans-serif 10 pixel is used

If loading a custom web font be sure to have the font loaded before you use it https://erikonarheim.com/posts/dont-test-fonts/

Hierarchy

• Graphic
  • Font

Implements

• FontRenderer

Index

Constructors

• constructor

Properties

• baseAlign
• bold
• color
• direction
• family
• filtering
• id
• lineDash
• lineHeight
• lineWidth
• opacity
• padding
• quality
• shadow
• showDebug
• size
• smoothing
• strokeColor
• style
• textAlign
• tint
• transform
• unit

Accessors

• flipHorizontal
• flipVertical
• fontString
• height
• localBounds
• origin
• rotation
• scale
• width

Methods

• clone
• cloneGraphicOptions
• draw
• isStale
• measureText
• measureTextWithoutCache
• render

Constructors

constructor

• new Font(options?: FontOptions & GraphicOptions & RasterOptions): Font

• Overrides Graphic.constructor

  Parameters

  • options: FontOptions & GraphicOptions & RasterOptions = {}

  Returns Font

Properties

publicbaseAlign

baseAlign: BaseAlign = BaseAlign.Top

publicbold

bold: boolean = false

publiccolor

color: Color = Color.Black

publicdirection

direction: Direction = Direction.LeftToRight

publicfamily

family: string = 'sans-serif'

publicfiltering

filtering: ImageFiltering = ImageFiltering.Blended

Set the font filtering mode, by default set to [[ImageFiltering.Blended]] regardless of the engine default smoothing

If you have a pixel style font that may be a reason to switch this to [[ImageFiltering.Pixel]]

readonlyid

id: number = ...

Inherited from Graphic.id

publiclineDash

lineDash: number[] = []

publiclineHeight

lineHeight: number = undefined

Font line height in pixels, default line height if unset

publiclineWidth

lineWidth: number = 1

publicopacity

opacity: number = 1

Inherited from Graphic.opacity

Gets or sets the opacity of the graphic, 0 is transparent, 1 is solid (opaque).

publicpadding

padding: number = 2

publicquality

quality: number = 2

Font quality determines the size of the underlying raster text, higher quality means less jagged edges. If quality is set to 1, then just enough raster bitmap is generated to render the text.

You can think of quality as how zoomed in to the text you can get before seeing jagged edges.

(Default 2)

publicshadow

shadow: { blur?: number; color?: Color; offset?: Vector } = null

Type declaration

• optionalblur?: number

• optionalcolor?: Color

• optionaloffset?: Vector

publicshowDebug

showDebug: boolean = false

Inherited from Graphic.showDebug

Gets or sets wether to show debug information about the graphic

publicsize

size: number = 10

publicsmoothing

smoothing: boolean = false

publicstrokeColor

strokeColor: Color

publicstyle

style: FontStyle = FontStyle.Normal

publictextAlign

textAlign: TextAlign = TextAlign.Left

publictint

tint: Color = null

Inherited from Graphic.tint

publictransform

transform: AffineMatrix = ...

Inherited from Graphic.transform

publicunit

unit: FontUnit = FontUnit.Px

Accessors

publicflipHorizontal

• get flipHorizontal(): boolean
• set flipHorizontal(value: boolean): void

• Inherited from Graphic.flipHorizontal

  Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)

  ---

  Returns boolean

• Inherited from Graphic.flipHorizontal

  Parameters

  • value: boolean

  Returns void

publicflipVertical

• get flipVertical(): boolean
• set flipVertical(value: boolean): void

• Inherited from Graphic.flipVertical

  Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)

  ---

  Returns boolean

• Inherited from Graphic.flipVertical

  Parameters

  • value: boolean

  Returns void

publicfontString

• get fontString(): string

• Returns string

publicheight

• get height(): number
• set height(value: number): void

• Inherited from Graphic.height

  Gets or sets the height of the graphic (always positive)

  ---

  Returns number

• Inherited from Graphic.height

  Parameters

  • value: number

  Returns void

publiclocalBounds

• get localBounds(): BoundingBox

• Overrides Graphic.localBounds

  Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.

  ---

  Returns BoundingBox

publicorigin

• get origin(): Vector
• set origin(value: Vector): void

• Inherited from Graphic.origin

  Gets or sets the origin of the graphic, if not set the center of the graphic is the origin

  ---

  Returns Vector

• Inherited from Graphic.origin

  Parameters

  • value: Vector

  Returns void

publicrotation

• get rotation(): number
• set rotation(value: number): void

• Inherited from Graphic.rotation

  Gets or sets the rotation of the graphic

  ---

  Returns number

• Inherited from Graphic.rotation

  Parameters

  • value: number

  Returns void

publicscale

• get scale(): Vector
• set scale(value: Vector): void

• Inherited from Graphic.scale

  Gets or sets the scale of the graphic, this affects the width and

  ---

  Returns Vector

• Inherited from Graphic.scale

  Parameters

  • value: Vector

  Returns void

publicwidth

• get width(): number
• set width(value: number): void

• Inherited from Graphic.width

  Gets or sets the width of the graphic (always positive)

  ---

  Returns number

• Inherited from Graphic.width

  Parameters

  • value: number

  Returns void

Methods

publicclone

• clone(): Font

• Overrides Graphic.clone

  Returns a new instance of the graphic that has the same properties

  ---

  Returns Font

publiccloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Inherited from Graphic.cloneGraphicOptions

  Returns GraphicOptions

publicdraw

• draw(ex: ExcaliburGraphicsContext, x: number, y: number): void

• Inherited from Graphic.draw

  Draw the whole graphic to the context including transform

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicisStale

• isStale(): boolean

• Inherited from Graphic.isStale

  Returns boolean

publicmeasureText

• measureText(text: string, maxWidth?: number): BoundingBox

• Implementation of FontRenderer.measureText

  Returns a BoundingBox that is the total size of the text including multiple lines

  Does not include any padding or adjustment

  ---

  Parameters

  • text: string

  • optionalmaxWidth: number

  Returns BoundingBox

  BoundingBox

publicmeasureTextWithoutCache

• measureTextWithoutCache(text: string, maxWidth?: number): BoundingBox

• Parameters

  • text: string

  • optionalmaxWidth: number

  Returns BoundingBox

publicrender

• render(ex: ExcaliburGraphicsContext, text: string, colorOverride: Color, x: number, y: number, maxWidth?: number): void

• Implementation of FontRenderer.render

  Parameters

  • ex: ExcaliburGraphicsContext

  • text: string

  • colorOverride: Color

  • x: number

  • y: number

  • optionalmaxWidth: number

  Returns void