<include url="%VIEWER%/plugins/showtext.xml" />
showtext(text, textstyle*)
<textstyle name="DEFAULT" origin="cursor" edge="bottom" xoffset="0" yoffset="-3" fadeintime="0.0" showtime="0.1" fadetime="0.0" font="Times" fontsize="12.0" bold="true" italic="false" textcolor="0x000000" textalign="none" padding="1" css="" width="" height="" vcenter="" background="true" backgroundcolor="0xFFFFFF" backgroundalpha="1.0" border="true" bordercolor="0x000000" borderalpha="1.0" borderwidth="1.0" roundedge="0" shadow="0.0" shadowrange="4.0" shadowangle="45" shadowcolor="0x000000" shadowalpha="1.0" textshadow="0.0" textshadowrange="4.0" textshadowangle="45" textshadowcolor="0x000000" textshadowalpha="1.0" alpha="1.0" parent="" noclip="true" />
Attribute name | Full variable name | Type | Default value |
name | textstyle[name].name | String | |
---|---|---|---|
The name of the textstyle (see the name notes). Use DEFAULT as name to overwrite the default textstyle settings. |
|||
Attribute name | Full variable name | Type | Default value |
origin edge xoffset yoffset |
textstyle[name].origin textstyle[name].edge textstyle[name].xoffset textstyle[name].yoffset |
String String int int |
"cursor" "bottom" 0 -3 |
Position of the text. Possible settings for origin:
|
|||
Attribute name | Full variable name | Type | Default value |
fadeintime showtime fadetime |
textstyle[name].fadeintime textstyle[name].showtime textstyle[name].fadetime |
Number Number Number |
0.0 0.1 0.0 |
The times (in seconds) how long the text will be shown:
|
|||
Attribute name | Full variable name | Type | Default value |
font fontsize bold italic |
textstyle[name].font textstyle[name].fontsize textstyle[name].bold textstyle[name].italic |
String Number Boolean Boolean |
"Times" 12.0 true false |
Attribute name | Full variable name | Type | Default value |
textcolor | textstyle[name].textcolor | int | 0x000000 |
The default color of the text. | |||
Attribute name | Full variable name | Type | Default value |
textalign | textstyle[name].textalign | String | "none" |
Align of the text: none, left, center, right. | |||
Attribute name | Full variable name | Type | Default value |
padding | textstyle[name].padding | String | "2" |
Padding / space in pixels around the text. Can be individually for each side. There are 4 different ways to set the paddings (same as in CSS):
|
|||
Attribute name | Full variable name | Type | Default value |
css | textstyle[name].css | String | "" |
|
|||
Attribute name | Full variable name | Type | Default value |
width height vcenter |
textstyle[name].width textstyle[name].height textstyle[name].vcenter |
String String Boolean | "" "" false |
Set fixed pixel-sizes for the text-field. By default the size will depend on the text content. vcenter - vertically center the text within a given fixed height. |
|||
Attribute name | Full variable name | Type | Default value |
background backgroundcolor backgroundalpha |
textstyle[name].background textstyle[name].backgroundcolor textstyle[name].backgroundalpha |
Boolean int Number |
true 0xFFFFFF 1.0 |
|
|||
Attribute name | Full variable name | Type | Default value |
border bordercolor borderalpha borderwidth |
textstyle[name].border textstyle[name].bordercolor textstyle[name].borderalpha textstyle[name].borderwidth |
Boolean int Number Number | false 0x000000 1.0 1.0 |
|
|||
Attribute name | Full variable name | Type | Default value |
roundedge | textstyle[name].roundedge | Number | 0.0 |
|
|||
Attribute name | Full variable name | Type | Default value |
shadow shadowrange shadowangle shadowcolor shadowalpha |
textstyle[name].shadow textstyle[name].shadowrange textstyle[name].shadowangle textstyle[name].shadowcolor textstyle[name].shadowalpha |
Number Number Number int Number |
0.0 4.0 45.0 0x000000 1.0 |
Put a box-shadow behind the textfield.
|
|||
Attribute name | Full variable name | Type | Default value |
textshadow textshadowrange textshadowangle textshadowcolor textshadowalpha |
textstyle[name].textshadow textstyle[name].textshadowrange textstyle[name].textshadowangle textstyle[name].textshadowcolor textstyle[name].textshadowalpha |
Number Number Number int Number |
0.0 4.0 45.0 0x000000 1.0 |
Put a shadow behind the text.
|
|||
Attribute name | Full variable name | Type | Default value |
alpha | textstyle[name].alpha | Number | 1.0 |
The alpha (transparency) value (0.0 - 1.0) of the textfield. | |||
Attribute name | Full variable name | Type | Default value |
parent | textstyle[name].parent | String | |
Assign a custom layer as parent element for the textfield: | |||
Attribute name | Full variable name | Type | Default value |
noclip | textstyle[name].noclip | Boolean | true |
Avoid the clipping of the textfield on the screen borders. The textfield will be always fully within the screen. |