pxt-calliope/docs/reference/images/plot-frame.md

38 lines
999 B
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# Plot Frame
2016-04-02 01:22:47 +02:00
The plot frame function.
2016-03-26 00:47:20 +01:00
2016-04-16 00:02:26 +02:00
Display an [Image](/reference/images/image) on the BBC micro:bit's [LED screen](/device/screen)
2016-03-26 00:47:20 +01:00
2016-04-18 17:33:09 +02:00
### JavaScript
2016-03-26 00:47:20 +01:00
```
export function plotFrame(_this: micro_bit.Image, index: number)
```
### Parameters
2016-04-13 17:27:45 +02:00
* index - [Number](/reference/types/number); which frame of the image to display
2016-03-26 00:47:20 +01:00
### Difference from `plot image`
The `plot frame` function takes the index of the frame (if there are two frames, then the possible indices are 0 and 1), whereas `plot image` accepts an offset (if there are two frames, the offset would range between 0 and 9).
### Example
```
let img = images.createImage(`
# . . . # # . . . #
. # . # . . # # # .
. . # . . . # # # .
. # . # . . # # # .
# . . . # # . . . #
`)
img.plotFrame(1)
```
### See also
2016-04-16 00:02:26 +02:00
[create image](/reference/images/create-image), [show animation](/reference/basic/show-animation), [image](/reference/images/image), [show image](/reference/images/show-image), [scroll image](/reference/images/scroll-image)
2016-03-26 00:47:20 +01:00