Rac.Text - Documentation

# | source: src/drawable/Text.js, line 45

String, position and format to draw a text.

An instance of this object contains the string and a Point used to determine the location of the drawn text. The Text.Format object determines the font, size, orientation angle, and the alignment relative to point to draw the text.

`instance.Text`

Instances of Rac contain a convenience rac.Text function to create Text objects with fewer parameters. This function also contains ready-made convenience objects, like rac.Text.hello, listed under instance.Text.

Example

let rac = new Rac()
let point = rac.Point(55, 77)
let format = rac.Text.Format('left', 'baseline')
// new instance with constructor
let text = new Rac.Text(rac, point, 'black quartz', format)
// or convenience function
let otherText = rac.Text(55, 77, 'black quartz', format)

See also:

Constructor

new Text(rac, point, string, format)

# | source: src/drawable/Text.js, line 45

Creates a new Text instance.

Parameters:

Name	Type	Description
`rac`	`Rac`	Instance to use for drawing and creating other objects
`point`	`Rac.Point`	The location for the drawn text
`string`	`String`	The string to draw
`format`	`Rac.Text.Format`	The format for the drawn text

Classes

Format

Members

format :Rac.Text.Format

# | source: src/drawable/Text.js, line 96

The alignment, angle, font, and size to use to draw the text.

point :Rac.Point

# | source: src/drawable/Text.js, line 84

The location where the text will be drawn.

The text will be drawn relative to this point based on the alignment and angle configuration of format.

rac :Rac

# | source: src/drawable/Text.js, line 73

Instance of Rac used for drawing and passed along to any created object.

string :String

# | source: src/drawable/Text.js, line 90

The string to draw.

Methods

equals(otherText) → {Boolean}

# | source: src/drawable/Text.js, line 132

Returns true when the string and point of both texts are equal; otherwise returns false.

When otherText is any class other that Rac.Text, returns false.

points are compared using point.equals.

The format objects are ignored in this comparison.

See also:

point.equals

Parameters:

Name	Type	Description
`otherText`	`Rac.Text`	A `Text` to compare

toString(digitsopt) → {String}

# | source: src/drawable/Text.js, line 111

Returns a string representation intended for human consumption.

Parameters:

Name	Type	Attributes	Default	Description
`digits`	`Number`	<optional>	`null`	The number of digits to print after the decimal point, when ommited all digits are printed

Example

// returns 'Text((55,77) "sphinx of black quartz")'
rac.Text(55, 77, 'sphinx of black quartz').toString()

withAngle(newAngle) → {Rac.Text}

# | source: src/drawable/Text.js, line 146

Returns a new Text and Format with format.angle set to the Angle derived from newAngle.

Parameters:

Name	Type	Description
`newAngle`	`Rac.Angle` \| `Number`	The angle for the new `Text` and `Text.Format`

withFont(newFontnullable) → {Rac.Text}

# | source: src/drawable/Text.js, line 158

Returns a new Text and Format with format.font set to newFont.

Parameters:

Name	Type	Attributes	Description
`newFont`	`String`	<nullable>	The font name for the new `Text` and `Text.Format`; can be set to `null`.

withSize(newSizenullable) → {Rac.Text}

# | source: src/drawable/Text.js, line 170

Returns a new Text and Format with format.size set to newSize.

Parameters:

Name	Type	Attributes	Description
`newSize`	`Number`	<nullable>	The font size for the new `Text` and `Text.Format`; can be set to `null`.