Rac.Text.Format - Documentation

Constructor

new Format(rac, hAlign, vAlign, angleopt, fontopt, sizeopt)

# | source: drawable/Text.Format.js, line 14

Creates a new Text.Format instance.

Parameters:

Name	Type	Attributes	Default	Description
`rac`	`Rac`			Instance to use for drawing and creating other objects
`hAlign`	`string`			The horizontal alignment, left-to-right; one of the values from `horizontalAlign`
`vAlign`	`string`			The vertical alignment, top-to-bottom; one of the values from `verticalAlign`
`angle`	`Rac.Angle`	<optional>	rac.Angle.zero	The angle towards which the text is drawn
`font`	`string`	<optional>	null	The font name
`size`	`number`	<optional>	null	The font size

Members

(static) horizontalAlign :object

# | source: drawable/Text.Format.js, line 31

Supported values for hAlign which dermines the left-to-right alignment of the drawn Text in relation to its text.point.

Properties:

Name	Type	Description
`left`	`string`	aligns `text.point` to the left edge of the drawn text
`center`	`string`	aligns `text.point` to the center, from side to
`right`	`string`	aligns `text.point` to the right edge of the drawn text

(static) verticalAlign :object

# | source: drawable/Text.Format.js, line 54

Supported values for vAlign which dermines the top-to-bottom alignment of the drawn Text in relation to its text.point.

Properties:

Name	Type	Description
`top`	`string`	aligns `text.point` to the top edge of the drawn text
`center`	`string`	aligns `text.point` to the center, from top to bottom, of the drawn text
`baseline`	`string`	aligns `text.point` to the baseline of the drawn text
`bottom`	`string`	aligns `text.point` to the bottom edge of the drawn text

angle :Rac.Angle

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

The angle towards which the text is drawn.

An angle of zero wil draw the text towards the right of the screen.

(nullable) font :string

# | source: drawable/Text.Format.js, line 143

The font name of the text to draw.

When set to null the font defined in rac.textFormatDefaults.font is used instead upon drawing.

hAlign :string

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

The horizontal alignment, left-to-right, to position a Text relative to its point.

Supported values are available through the horizontalAlign object.

rac :Rac

# | source: drawable/Text.Format.js, line 100

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

(nullable) size :number

# | source: drawable/Text.Format.js, line 154

The font size of the text to draw.

When set to null the size defined in rac.textFormatDefaults.size is used instead upon drawing.

vAlign :string

# | source: drawable/Text.Format.js, line 122

The vertical alignment, top-to-bottom, to position a Text relative to its point.

Supported values are available through the verticalAlign object.

Methods

equals(otherFormat) → {boolean}

# | source: drawable/Text.Format.js, line 193

Returns true when all members, except rac, of both formats are equal, otherwise returns false.

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

See:

Rac.Angle#equals

Parameters:

Name	Type	Description
`otherFormat`	`Rac.Text.Format`	A `Text.Format` to compare

reverse() → {Rac.Text.Format}

# | source: drawable/Text.Format.js, line 254

Returns a new Text.Format that will draw a text reversed, upside-down, in generally the same position as this would draw the same text.

toString(digitsopt) → {string}

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

Returns a string representation intended for human consumption.

(new Rac.Text.Format(rac, 'left', 'top', 0.5, 'sans', 14)).toString()
// Returns: Text.Format(ha:left va:top a:0.5 f:"sans" s:14)

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

withAngle(newAngle) → {Rac.Text.Format}

# | source: drawable/Text.Format.js, line 209

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

Parameters:

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

withFont(newFontnullable) → {Rac.Text.Format}

# | source: drawable/Text.Format.js, line 225

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

Parameters:

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

withSize(newSizenullable) → {Rac.Text.Format}

# | source: drawable/Text.Format.js, line 240

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

Parameters:

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