From ad6ef04b1f8ce5f1867b7c9286887489075414e0 Mon Sep 17 00:00:00 2001 From: Ron Hale-Evans Date: Mon, 18 Jul 2016 15:18:40 -0700 Subject: [PATCH] Fixing parameters --- docs/reference/images/create-big-image.md | 8 +++++++- docs/reference/images/create-image.md | 5 +++++ docs/reference/images/scroll-image.md | 9 +++++++-- docs/reference/images/show-image.md | 5 +++++ 4 files changed, 24 insertions(+), 3 deletions(-) diff --git a/docs/reference/images/create-big-image.md b/docs/reference/images/create-big-image.md index 8ac17640..cb3562a6 100644 --- a/docs/reference/images/create-big-image.md +++ b/docs/reference/images/create-big-image.md @@ -4,7 +4,7 @@ Make a big [image](/reference/images/image) (picture) for the micro:bit [LED screen](/device/screen). The big image made of two squares. Each of the squares is five LEDs on a side, like a regular image. -```blocks +```sig images.createBigImage(` . . # . . . . # . . . # # # . . . # . . @@ -14,6 +14,12 @@ images.createBigImage(` `); ``` +### Parameters + +* ``leds`` is a [string](/reference/types/string) that says which LEDs +on the screen should be on and which should be off. + + ### Example: Flip-flopping arrow This program makes a big image with a picture of an arrow pointing up, diff --git a/docs/reference/images/create-image.md b/docs/reference/images/create-image.md index 550f0f93..1ef990ae 100644 --- a/docs/reference/images/create-image.md +++ b/docs/reference/images/create-image.md @@ -13,6 +13,11 @@ images.createImage(` `) ``` +### Parameters + +* ``leds`` is a [string](/reference/types/string) that says which LEDs +on the screen should be on and which should be off. + ### Example: Flip-flopping arrow If you press button `A`, this program will make a picture of an diff --git a/docs/reference/images/scroll-image.md b/docs/reference/images/scroll-image.md index 19379977..7b041286 100644 --- a/docs/reference/images/scroll-image.md +++ b/docs/reference/images/scroll-image.md @@ -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. diff --git a/docs/reference/images/show-image.md b/docs/reference/images/show-image.md index 8ce2f38c..f68115ef 100644 --- a/docs/reference/images/show-image.md +++ b/docs/reference/images/show-image.md @@ -4,6 +4,11 @@ Show an [image](/reference/images/image) (picture) on the [LED screen](/device/screen). After the micro:bit shows an image, it will pause for 400 milliseconds (1000 milliseconds is one second). +```sig +let item: Image = null; +item.showImage(0); +``` + ### Parameters * an [image](/reference/images/image) (picture). It is usually a square with five LEDs on a side, but it might be wider.