Marquee

From HSYCO
Revision as of 11:15, 27 January 2014 by Hsyco (talk | contribs) (→‎Syntax)
Jump to navigation Jump to search
Note  For a description and a complete list of UI Objects, see UI Objects.

Shows a generic text just like the text object, but with a scrolling effect.

Parameters

  • id: the object's ID, used by UISets. Required
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • size: the text box's width and height
  • direction: the scrolling direction:
    • left: from right to left
    • right: from left to right
    • up: scrolls up
    • down: scrolls down
  • speed: scroll speed; minimum speed is 1; larger numbers increase the speed
  • text: the text. Can contain HTML tags
  • css: optional, and defines the CSS style

Syntax

(marquee[!<id>] <pos>; <width>; <height>; <direction>; <speed>; <text>; <css>)

E.g.

(marquee!mymarquee r1c1; 200; 50; right; 1; scrolling 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)

Chart attributes

Name Value Description
width number Text box's width in pixels
height number Text box's height in pixels
paused true Scrolling paused
false Default: scrolling
text string Set the text