Fixing parameters

This commit is contained in:
Ron Hale-Evans
2016-07-18 15:18:40 -07:00
parent 2c09b7794f
commit ad6ef04b1f
4 changed files with 24 additions and 3 deletions

View File

@ -3,9 +3,14 @@
Scroll (slide) an [image](/reference/images/image) (picture) from one
side to the other of the [LED screen](/device/screen).
```sig
let item: Image = null;
item.scrollImage(5, 200);
```
### Parameters
* ``offset`` is a [number](/reference/types/number) that means
* a [number](/reference/types/number) that means
how many LEDs to scroll at a time, from right to left or
left to right. If you use a positive number like `2`, the image
will scroll from the right side of the screen to the left.
@ -15,7 +20,7 @@ side to the other of the [LED screen](/device/screen).
image. It is a square with five LEDs on a side). This is
useful for **animation**.
* ``interval (ms)`` is a [number](/reference/types/number) that means
* a [number](/reference/types/number) that means
how many milliseconds to wait before scrolling the amount that
``offset`` says. (1000 milliseconds is one second.) The bigger you
make this number, the slower the image will scroll.