TextComponent | g.frame

Hierarchy

TextViewerModule
- TextComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextComponent(options: ITextComponentOptions): TextComponent

Overrides TextViewerModule.constructor
- Defined in packages/g.frame.components.text/src/TextComponent.ts:5
Parameters
- options: ITextComponentOptions
Returns TextComponent

Properties

material

material: MeshBasicMaterial

mesh

mesh: Mesh

options

options: ITextComponentOptions

Methods

setText

setText(text: string): void

- Defined in packages/g.frame.components.text/src/TextComponent.ts:13
Parameters
- text: string
Returns void

updateElement

updateElement(options: ITextViewerModuleOptions): Mesh

Inherited from TextViewerModule.updateElement
- Defined in packages/g.frame.components.text/src/TextViewerModule.ts:205
Function to draw text, background on canvas and get Mesh with CanvasTexture on it

Parameters
- options: ITextViewerModuleOptions
  
  Options to draw
Returns Mesh

Static generateFontProperty

generateFontProperty(font: ITextViewerModuleOptionsTextStyle): string

Inherited from TextViewerModule.generateFontProperty
- Defined in packages/g.frame.components.text/src/TextViewerModule.ts:26
Parameters
- font: ITextViewerModuleOptionsTextStyle
Returns string

Static getTextStyleSeparated

getTextStyleSeparated(context: CanvasRenderingContext2D): ITextViewerModuleOptionsTextStyle

Inherited from TextViewerModule.getTextStyleSeparated
- Defined in packages/g.frame.components.text/src/TextViewerModule.ts:30
Parameters
- context: CanvasRenderingContext2D
Returns ITextViewerModuleOptionsTextStyle

Static roundRect

roundRect(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius?: any | number, fill?: boolean, stroke?: boolean): void

Inherited from TextViewerModule.roundRect
- Defined in packages/g.frame.components.text/src/TextViewerModule.ts:146
Draws a rounded rectangle using the current state of the canvas. If you omit the last three params, it will draw a rectangle outline with a 5 pixel border radius

Parameters
- ctx: CanvasRenderingContext2D
  
  Context of the canvas
- x: number
  
  The top left x coordinate
- y: number
  
  The top left y coordinate
- width: number
  
  The width of the rectangle
- height: number
  
  The height of the rectangle
- Default value radius: any | number = 5
- Default value fill: boolean = false
- Default value stroke: boolean = false
Returns void

Static wrapText

wrapText(ctx: CanvasRenderingContext2D, text: string, x: number, y: number, maxWidth: number, lineHeight: number, wrapOnLines: boolean): void

Inherited from TextViewerModule.wrapText
- Defined in packages/g.frame.components.text/src/TextViewerModule.ts:52
Function to wrap text on lines

Parameters
- ctx: CanvasRenderingContext2D
  
  Context of the canvas
- text: string
  
  Text to write
- x: number
  
  Left coordinate of first letter
- y: number
  
  Top coordinate of first letter
- maxWidth: number
  
  Max width in px of each line
- lineHeight: number
  
  Line height in px
- wrapOnLines: boolean
  
  Text should be wrapped on lines
Returns void

Generated using TypeDoc