User's Reference - Text

### Text

Category

Annotation

Function

Displays text.

Syntax

    text = Text(string, position, height, font, direction, up);

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`string` | string or field | none | text to be displayed
`position` | vector | [0 0 0] | placement of displayed text
`height` | scalar | 1 | height of the text (in world coordinates)
`font` | string | "variable" | text font
`direction` | vector | [1 0 0] | orientation of the baseline
`up` | vector | perpendicular to baseline | orientation of vertical strokes of text font

Outputs

Name | Type | Description
--- | --- | ---
`text` | color field | renderable string object

Functional Details

This module produces text that is displayed in space.

`string` | specifies the text to be displayed. If the parameter value is a string, that string is displayed. If the parameter value is a field, its "data" component must be TYPE_STRING. The data may be position or connection dependent: position dependent: each string in the "data" component is displayed at its corresponding position. connection dependent: each string is displayed at the center of its corresponding connection element.
`position` | specifies in world units the placement of the displayed text. It is used only when `string` is not a field.
`height` | specifies the height of the text, in world units.
`font` | specifies the font used for displayed text. You can specify any of the defined fonts supplied with Data Explorer. These include a variable-width font ("variable," the default) and a fixed-width font ("fixed"):
    area          gothicit_t       pitman                roman_ext
    cyril_d       greek_d          roman_d               script_d
    fixed         greek_s          roman_dser            script_s
    gothiceng_t   italic_d         roman_s               variable
    gothicger_t   italic_t         roman_tser
For more information, see Appendix E. "Data Explorer Fonts" in IBM Visualization Data Explorer User's Guide.
`direction` | specifies the orientation of the baseline (see Note in next description). For example, a value of 10 for this parameter specifies that the text is aligned with the x-axis.
`up` | specifies the orientation of the vertical strokes of the font used for the displayed text. Note: For string data in a field, the orientation of baseline and text can specified by using "tangents" and "binormals" components. In that way, each string can be oriented individually. These components should have the same dependency as "data" The "tangents" component corresponds to `direction` and "binormals" to `up`. The parameter specifications will override those of the field components.

Components

Creates new "positions," "connections," and "colors" components.

Example Visual Program

    UsingTextAndTextGlyphs.net

See Also

Caption, Color, Format

[ OpenDX Home at IBM | OpenDX.org ]