pxt-calliope/docs/reference/images/show-image.md
Juri Wolf a93febb5b7
Map and clean deprecated functions (#175)
* add image and deprecated arrow functions

* update locales

* map basic.showArrow

* map arrow blocks

* map & remove arrow images

* remove arrow blocks

* update locales

* remove & patch:
rgbw -> rgb
button/pin pressed -> button/pin event
loudness -> soundLevel

* update ts mappings for arrows

* add wip ts patch rules

* update .blocks files

* use Click instead of Down as default in Documentation and tests

* patch test.blocks

* fix lowercase name tag

* update test.blocks

* update blocks test files

* update blocks test files

* format block files

* pass blocks file tests

* fix ts mapping

* fix color.defl value

closes https://github.com/microsoft/pxt-calliope/issues/136

* fix ts mappings

- add optional spacing at the end of rgbw()
- map up to v4.0.19

* add suggested changes

* replace innerText by textContent

Co-authored-by: JW <gitkraken@juriwolf.de>
Co-authored-by: Juri <info@juriwolf.de>
2022-04-26 10:28:42 -07:00

1.6 KiB

Show Image

Show an image (picture) on the LED screen. After the @boardname@ shows an image, it will pause for 400 milliseconds (1000 milliseconds is one second).

let item: Image = null;
item.showImage(0);

Parameters

  • an image (picture). It is usually a square with five LEDs on a side, but it might be wider.
  • a number that says how many LEDs from the left of the picture the @boardname@ should start. 0 means start at the first frame of the picture, 5 means start at the second frame, 10 means start at the third, and so on.

Example: Flip-flopping arrow

This program makes a big image with a frame of an arrow pointing up, and a frame of an arrow pointing down. If you press button A, the program will use show image to show the arrow pointing up. (It starts 0 LEDs from the left in the big image.) If you press button B, the program will use show image to show the arrow pointing down, which starts 5 LEDs from the left.

let arrows = images.createBigImage(`
    . . # . .   . . # . .
    . # # # .   . . # . .
    # . # . #   # . # . #
    . . # . .   . # # # .
    . . # . .   . . # . .
    `);
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {
    arrows.showImage(0);
});
input.onButtonEvent(Button.B, ButtonEvent.Click, () => {
    arrows.showImage(5);
});

See also

image, create image, create big image, scroll image, show animation