Update some info in 'plotBarGraph' ()

* edits for the ref page

* fix temp example text

* spell maximum
This commit is contained in:
Galen Nickel 2019-04-09 11:01:39 -07:00 committed by GitHub
parent 0868befa5c
commit 3424862910
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,30 +1,29 @@
# Plot Bar Graph
# plot Bar Graph
Displays a bar graph of the numbers you say.
A bar graph is a kind of chart that shows numbers as lines with different lengths.
Display a bar graph for a number value.
```sig
led.plotBarGraph(2, 20);
```
A bar graph is a kind of chart that shows numbers as lines with different lengths.
## Parameters
* ``value`` is a [number](/types/number) that means what you
* **value**: a [number](/types/number) that is the value of what you
are measuring or trying to show. For example, if you are measuring
the temperature of ice with the @boardname@, ``value`` might be `0`
because the temperature might be 0 degrees centigrade.
* ``high`` is a [number](/types/number) that means the highest
possible number that the ``value`` parameter can be. This number is
also the tallest that the lines in the bar chart can be.
if the temperature is 0 degrees Celsius.
* **high**: a [number](/types/number) that is the highest
possible number (maximum) that the **value** parameter can be. The lines in the bar graph will reach their highest point when **value** reaches this number. If **high** is `0`, then the largest value recently plotted is used as the maximum.
## Example: chart acceleration
This program shows a bar graph of the [acceleration](/reference/input/acceleration)
Show a bar graph of the [acceleration](/reference/input/acceleration)
in the `x` direction of the @boardname@.
The @boardname@'s `x` direction is from left to right (or right to left).
The more you speed up moving the @boardname@ in this direction,
the taller the lines in the bar graph will be,
until they are as tall as the parameter `high` says they can be.
The faster you move the @boardname@ in this direction,
the taller the lines in the bar graph will be. The **high** paramter is `1023` which sets the highest possible value of acceleration to show.
```blocks
basic.forever(() => {