Class ScalerContext

Hierarchy

ScalerContext
- ScalerContext

Index

Properties

Methods

setCanvas setContext isEmoji generateImage fontString getTextAdvance getTextBounds generateFontMetrics loadCanvas

Constructors

Properties

`Static` canvas

canvas: HTMLCanvasElement | OffscreenCanvas

`Static` context

context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D

Methods

`Static` setCanvas

setCanvas(canvas: HTMLCanvasElement | OffscreenCanvas): void
Parameters
- canvas: HTMLCanvasElement | OffscreenCanvas
Returns void
Inherited from ScalerContext.setCanvas
- Defined in src/core/scaler-context.ts:11

`Static` setContext

setContext(context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D): void
Parameters
- context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D
Returns void
Inherited from ScalerContext.setContext
- Defined in src/core/scaler-context.ts:15

`Static` isEmoji

isEmoji(text: string): boolean
Parameters
- text: string
Returns boolean
Inherited from ScalerContext.isEmoji
- Defined in src/core/scaler-context.ts:19

generateImage

generateImage(text: string, bounds: Rect): OffscreenCanvas
Parameters
- text: string
- bounds: Rect
Returns OffscreenCanvas
Overrides ScalerContext.generateImage
- Defined in src/wechat/scaler-context.ts:7

fontString

fontString(): string
Returns string
Inherited from ScalerContext.fontString
- Defined in src/core/scaler-context.ts:41

getTextAdvance

getTextAdvance(text: string): number
Parameters
- text: string
Returns number
Inherited from ScalerContext.getTextAdvance
- Defined in src/core/scaler-context.ts:60

getTextBounds

getTextBounds(text: string): Rect
Parameters
- text: string
Returns Rect
Inherited from ScalerContext.getTextBounds
- Defined in src/core/scaler-context.ts:66

generateFontMetrics

generateFontMetrics(): {
    ascent: number;
    descent: number;
    xHeight: number;
    capHeight: number;
}
Returns {
    ascent: number;
    descent: number;
    xHeight: number;
    capHeight: number;
}
- ascent: number
- descent: number
- xHeight: number
- capHeight: number
Inherited from ScalerContext.generateFontMetrics
- Defined in src/core/scaler-context.ts:80

`Protected` loadCanvas

loadCanvas(): void
Returns void
Overrides ScalerContext.loadCanvas
- Defined in src/wechat/scaler-context.ts:17

Constructors

constructor

new ScalerContext(fontName: string, fontStyle: string, size: number, fauxBold?: boolean, fauxItalic?: boolean): ScalerContext
Parameters
- fontName: string
- fontStyle: string
- size: number
- fauxBold: boolean = false
- fauxItalic: boolean = false
Returns ScalerContext
Inherited from ScalerContext.constructor
- Defined in src/core/scaler-context.ts:32

Generated using TypeDoc