Difference between revisions of "Text"

From HSYCO
Jump to navigation Jump to search
(Created page with "{{UI Object Header}} Shows a generic text. == Parameters == *'''id''': the object's ID, used by UISets. Required *'''position''': the object's position. Use the pixels or row...")
 
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
*'''id''': the object's ID, used by UISets. Required
 
*'''id''': the object's ID, used by UISets. Required
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
*'''size''': the text box's width and height
 
 
*'''text''': the text. Can contain HTML tags
 
*'''text''': the text. Can contain HTML tags
 
*'''css''': optional, and defines the CSS style
 
*'''css''': optional, and defines the CSS style
  
 
== Syntax ==
 
== Syntax ==
  (text[!<id>] <pos>; <width>; <height>; <text>; <css>)
+
  (text[!<id>] <pos>; <text>; <css>)
 
E.g.
 
E.g.
  (text!mytext r1c1; 200; 50; text; color:blue)
+
  (text!mytext r1c1; text; color:blue)
  
 
== UI Attributes ==
 
== UI Attributes ==
 
{{UI Object Attributes (Common)}}
 
{{UI Object Attributes (Common)}}
=== Chart attributes ===
+
=== Text attributes ===
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 22: Line 21:
 
!Description
 
!Description
 
|-
 
|-
|width
 
|number
 
|Text box's width in pixels
 
|-
 
 
|height
 
|number
 
|Text box's height in pixels
 
|-
 
 
 
|text
 
|text
 
|string
 
|string

Latest revision as of 10:33, 14 February 2014

Note  For a description and a complete list of UI Objects, see UI Objects.

Shows a generic text.

Parameters

  • id: the object's ID, used by UISets. Required
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • text: the text. Can contain HTML tags
  • css: optional, and defines the CSS style

Syntax

(text[!<id>] <pos>; <text>; <css>)

E.g.

(text!mytext r1c1; text; color:blue)

UI Attributes

Common attributes

Name Value Description
pos x<x>y<y> Position specified as x/y coordinates. E.g. x-5y10
r<r>c<c> Position specified as row/column. E.g. r1c2
visible true Default. Show the object
false Hide the object
blink true | slow Blink the object at a slow speed
fast Blink the object at a fast speed
false Stop the blinking
opacity 0.0 ... 1.0 Object opacity from 0 (not visible) to 1 (fully visible)

Text attributes

Name Value Description
text string Set the text