Studio

Z.Text

Inherits from Z.Node

Description

The Z.Text object renders text using a Z.Font.

For more information see Working With Text.

Provided by Z.Text

Constructor

Z.Text( ) Constructs a new Z.Text object.

Enumerations

HAlign The horizontal alignment of text in the bounding box.
Layout The different layout modes.
VAlign The vertical alignment of text in the bounding box.

Functions

ellipsis( ) Gets the text to display where the node truncates lengthy text.
ellipsis(...) Sets the text to display where the node truncates lengthy text.
font( ) Gets the Z.Font for this object.
font(...) Sets the Z.Font for this object.
hAlign( ) Gets the horizontal alignment of text in the bounding box.
hAlign(...) Sets the horizontal alignment of text in the bounding box.
layerMode( ) Gets the layer mode of the node.
layerMode(...) Sets the layer mode of the node.
layout( ) Gets the layout mode for this object.
layout(...) Sets the layout mode for this object.
lineScale( ) Gets the width of the bounding box for the text to appear in.
lineScale(...) Sets the width of the bounding box for the text to appear in.
lineSpacing( ) Gets the distance between the center of each line, as a proportion of line height.
lineSpacing(...) Sets the distance between the center of each line, as a proportion of line height.
lines( ) Gets the number of lines to display if the layout is Z.Text.Layout.wrap.
lines(...) Sets the number of lines to display if the layout is Z.Text.Layout.wrap.
renderSorted( ) Gets whether the node is to be sorted in depth and rendered along with other renderSorted nodes.
renderSorted(...) Sets whether the node is to be sorted in depth and rendered along with other renderSorted nodes.
shadow( ) Gets the 3D offset of a shadow to display.
shadow(...) Sets the 3D offset of a shadow to display.
shadowColor( ) Gets the color of the text shadow.
shadowColor(...) Sets the color of the text shadow.
text( ) Gets the text to be displayed.
text(...) Sets the text to be displayed.
textColor( ) Gets the color to apply to the displayed text.
textColor(...) Sets the color to apply to the displayed text.
vAlign( ) Gets the vertical alignment of text in the bounding box.
vAlign(...) Sets the vertical alignment of text in the bounding box.

Inherited from Z.Node

Functions

blend( ) Gets the type of blending used to render this object.
blend(...) Sets the type of blending used to render this object
color( ) Gets the color of the node.
color(...) Sets the color of the node.
cullFaces( ) Gets the type of culling to performed on this object.
cullFaces(...) Sets the type of culling to performed on this object.
enabled( ) Gets the value of enabled for the node.
enabled(...) Sets the value of enabled for the node.
position( ) Gets the position of the node.
position(...) Sets the position of the node
relativeTo( ) Gets an array of nodes that this node's location is relative to.
relativeTo(...) Sets the node(s) that this node's location is relative to.
relativeToProp( ) Gets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
relativeToProp(...) Sets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
rotation( ) Gets the rotation of the node.
rotation(...) Sets the rotation of the node.
scale( ) Gets the scale of the node.
scale(...) Sets the scale of the node.
visible( ) Gets the visibility of the node.
visible(...) Sets the visibility of this node.

Inherited from Z.Base

Functions

emit(...) Calls the handler functions attached to an event.
hasTag(...) Returns true if this object has the specified tag.
off(...) Removes a handler function from an event.
on(...) Attaches a handler function to an event.
one(...) Attaches a single-use handler function to an event.
pushTag(...) Adds a tag to this object.
removeTag(...) Removes a tag from this object.
tags( ) Gets an array of the tags that this object belongs to.
tags(...) Sets the array of the tags that this object belongs to.
Open in new window