pxt-calliope/docs/reference/images/plot-frame.md
2016-04-13 08:27:45 -07:00

42 lines
1.1 KiB
Markdown

# Plot Frame
The plot frame function.
Display an [Image](/reference/image/image) on the BBC micro:bit's [LED screen](/device/screen)
### KindScript
```
export function plotFrame(_this: micro_bit.Image, index: number)
```
### Parameters
* index - [Number](/reference/types/number); which frame of the image to display
### 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)
```
### Lessons
[smiley](/lessons/smiley), [flashing heart](/lessons/flashing-heart), [magic logo](/lessons/magic-logo)
### See also
[create image](/reference/images/create-image), [show animation](/reference/basic/show-animation), [image](/reference/image/image), [show image](/reference/images/show-image), [scroll image](/reference/images/scroll-image)