Class Text

Base class for drawable and animatable shapes

Hierarchy (View Summary)

Shape
- Text

Constructors

constructor

new Text(fontFamily?: string, content?: string): Text
Parameters
- fontFamily: string = "default"
- content: string = "Hello"
Returns Text
Overrides Shape.constructor
- Defined in text/Text.ts:12

Properties

animations

animations: Ganimation[] = []

`Optional`bounce

bounce?: boolean = false

bounceFriction

bounceFriction: number = 0

drawShape

drawShape: "rect" | "point" | "polygon" = "rect"

durationFrames

durationFrames: number = Infinity

fill

fill: string = "none"

fontFamily

fontFamily: string = "default"

height

height: number = 100

letterSpacing

letterSpacing: number = 0

pivot

pivot: [number, number] = ...

position

position: [number, number] = ...

radius

radius: number = 50

rotation

rotation: number = 0

startFrame

startFrame: number = 0

stroke

stroke: string = "black"

strokeWidth

strokeWidth: number = 0

text

text: string = "Hello"

type

type: string = "Animation"

width

width: number = 100

Accessors

x

get x(): number
Returns number
Inherited from Shape.x
- Defined in Shape.ts:118

y

get y(): number
Returns number
Inherited from Shape.y
- Defined in Shape.ts:122

Methods

grow

grow(options: GanimationOptions): this
Parameters
- options: GanimationOptions
Returns this
Inherited from Shape.grow
- Defined in Shape.ts:174

hue

hue(value?: number, alpha?: number): number | Text
Parameters
- Optionalvalue: number
- Optionalalpha: number
Returns number | Text
Inherited from Shape.hue
- Defined in Shape.ts:130

move

move(options: GanimationOptions): this
Parameters
- options: GanimationOptions
Returns this
Inherited from Shape.move
- Defined in Shape.ts:187

rotate

rotate(options: GanimationOptions): this
Parameters
- options: GanimationOptions
Returns this
Inherited from Shape.rotate
- Defined in Shape.ts:147

setBounce

setBounce(value: boolean, bounceFriction?: number): this
Parameters
- value: boolean
- bounceFriction: number = 0
Returns this
Inherited from Shape.setBounce
- Defined in Shape.ts:56

setDrawShape

setDrawShape(value: "rect" | "point"): this
Parameters
- value: "rect" | "point"
Returns this
Inherited from Shape.setDrawShape
- Defined in Shape.ts:111

setDurationFrames

setDurationFrames(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setDurationFrames
- Defined in Shape.ts:106

setFill

setFill(value: string): this
Parameters
- value: string
Returns this
Inherited from Shape.setFill
- Defined in Shape.ts:51

setFontFamily

setFontFamily(value: string): this
Parameters
- value: string
Returns this
- Defined in text/Text.ts:36

setHeight

setHeight(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setHeight
- Defined in Shape.ts:40

setLetterSpacing

setLetterSpacing(value: number): this
Parameters
- value: number
Returns this
- Defined in text/Text.ts:41

setPivot

setPivot(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from Shape.setPivot
- Defined in Shape.ts:86

setPosition

setPosition(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from Shape.setPosition
- Defined in Shape.ts:81

setRadius

setRadius(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setRadius
- Defined in Shape.ts:96

setRotation

setRotation(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setRotation
- Defined in Shape.ts:91

setSize

setSize(value: number): this
Parameters
- value: number
Returns this
Overrides Shape.setSize
- Defined in text/Text.ts:31

setStartFrame

setStartFrame(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setStartFrame
- Defined in Shape.ts:101

setStroke

setStroke(value: string): this
Parameters
- value: string
Returns this
Inherited from Shape.setStroke
- Defined in Shape.ts:61

setStrokeWidth

setStrokeWidth(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setStrokeWidth
- Defined in Shape.ts:66

setText

setText(value: string): this
Parameters
- value: string
Returns this
- Defined in text/Text.ts:26

setType

setType(value: string): this
Parameters
- value: string
Returns this
Inherited from Shape.setType
- Defined in Shape.ts:30

setWidth

setWidth(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setWidth
- Defined in Shape.ts:35

setX

setX(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setX
- Defined in Shape.ts:71

setY

setY(value: number): this
Parameters
- value: number
Returns this
Inherited from Shape.setY
- Defined in Shape.ts:76

translate

translate(options: GanimationOptions): this
Parameters
- options: GanimationOptions
Returns this
Inherited from Shape.translate
- Defined in Shape.ts:160

Class Text

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Text

Properties

animations

Optionalbounce

bounceFriction

drawShape

durationFrames

fill

fontFamily

fontSize

height

letterSpacing

pivot

position

radius

rotation

startFrame

stroke

strokeWidth

text

type

width

Accessors

x

Returns number

y

Returns number

Methods

grow

Parameters

Returns this

hue

Parameters

Returns number | Text

move

Parameters

Returns this

rotate

Parameters

Returns this

setBounce

Parameters

Returns this

setDrawShape

Parameters

Returns this

setDurationFrames

Parameters

Returns this

setFill

Parameters

Returns this

setFontFamily

Parameters

Returns this

setHeight

Parameters

Returns this

setLetterSpacing

Parameters

Returns this

setPivot

Parameters

Returns this

setPosition

Parameters

Returns this

setRadius

Parameters

Returns this

`Optional`bounce