# Two.Text
Extends: Two.Shape
This is a primitive class for creating drawable text that can be added to the scenegraph.
# Constructor
Argument | Description |
---|---|
message | The String to be rendered to the scene. |
x | The position in the x direction for the object. |
y | The position in the y direction for the object. |
styles | An object where styles are applied. Attribute must exist in Two.Text.Properties. |
# Measure
Two.Measure
Returns: Object
- The width and height of the Two.Text instance.
Argument | Description |
---|---|
text | The instance of Two.Text to measure. |
# fromObject
Two.Text.fromObject
Returns: Two.Text
Argument | Description |
---|---|
obj | Object notation of a Two.Text to create a new instance |
# value
Two.Text.value
The characters to be rendered to the the screen. Referred to in the documentation sometimes as the message
.
# family
Two.Text.family
The font family Two.js should attempt to register for rendering. The default value is 'sans-serif'
. Comma separated font names can be supplied as a "stack", similar to the CSS implementation of font-family
.
# leading
Two.Text.leading
The height between lines measured from base to base in Two.js point space. Defaults to 17
.
# alignment
Two.Text.alignment
Alignment of text in relation to Two.Text.translation's coordinates. Possible values include 'left'
, 'center'
, 'right'
. Defaults to 'center'
.
# baseline
Two.Text.baseline
The vertical aligment of the text in relation to Two.Text.translation's coordinates. Possible values include 'top'
, 'middle'
, 'bottom'
, and 'baseline'
. Defaults to 'baseline'
.
# style
Two.Text.style
The font's style. Possible values include 'normal
', 'italic'
. Defaults to 'normal'
.
# weight
Two.Text.weight
A number at intervals of 100 to describe the font's weight. This compatibility varies with the typeface's variant weights. Larger values are bolder. Smaller values are thinner. Defaults to '500'
.
# decoration
Two.Text.decoration
String to delineate whether text should be decorated with for instance an 'underline'
. Defaults to 'none'
.
# direction
Two.Text.direction
String to determine what direction the text should run. Possibly values are 'ltr'
for left-to-right and 'rtl'
for right-to-left. Defaults to 'ltr'
.
# fill
Two.Text.fill
The value of what the text object should be filled in with.
See: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value (opens new window) for more information on CSS's colors as String
.
# stroke
Two.Text.stroke
The value of what the text object should be filled in with.
See: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value (opens new window) for more information on CSS's colors as String
.
# dashes
Two.Text.dashes
Array of numbers. Odd indices represent dash length. Even indices represent dash space.
A list of numbers that represent the repeated dash length and dash space applied to the stroke of the text.
See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray (opens new window) for more information on the SVG stroke-dasharray attribute.
# clone
Two.Text.clone
Returns: Two.Text
Argument | Description |
---|---|
parent | The parent group or scene to add the clone to. |
Create a new instance of Two.Text with the same properties of the current text object.
# toObject
Two.Text.toObject
Returns: Object
Return a JSON compatible plain object that represents the text object.
# dispose
Two.Text.dispose
Returns: Two.Text
Release the text's renderer resources and detach all events. This method disposes fill and stroke effects (calling dispose() on Gradients and Textures for thorough cleanup) while preserving the renderer type for potential re-attachment to a new renderer.
# getBoundingClientRect
Two.Text.getBoundingClientRect
Returns: Object
- Returns object with top, left, right, bottom, width, height attributes.
Argument | Description |
---|---|
shallow | Describes whether to calculate off local matrix or world matrix. |
Return an object with top, left, right, bottom, width, and height parameters of the text object.