Skip to content

Commit 452dd16

Browse files
committed
Minor documentation text revision.
1 parent 747482e commit 452dd16

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ Defaults to **false**.
463463

464464
*Available since v4.0.0*
465465

466-
Performs an *n*th-root to amplify low energy values when using linear amplitude.
466+
Performs an *n*th-root to amplify low energy values when using linear scale for the amplitude.
467467

468468
It should be a number >= 1, while 1 means no boosting. Only effective when [`linearAmplitude`](#linearamplitude-boolean) is set to *true*.
469469

@@ -1052,7 +1052,7 @@ See [`minFreq` and `maxFreq`](#minfreq-number) for lower and upper limit values.
10521052
10531053
*Available since v3.2.0*
10541054
1055-
Customize parameters used to create the [LEDs display effect](#ledbars-boolean).
1055+
Customize parameters used to create the [`ledBars`](#ledbars-boolean) effect.
10561056
10571057
`params` should be an object with the following structure:
10581058
@@ -1066,9 +1066,9 @@ const params = {
10661066
10671067
property | description
10681068
----------|-------------
1069-
`maxLeds` | maximum desired number of LED elements per analyzer bar
1069+
`maxLeds` | **maximum** desired number of LED elements per analyzer bar
10701070
`spaceV` | vertical spacing ratio, relative to the LED height (**1** means spacing is the same as the LED height)
1071-
`spaceH` | **minimum** horizontal spacing ratio, relative to the available width (**0.5** means half of the width is used for spacing and half for the LED); behaves exactly like [barSpace](#barspace-number) (values >= 1 are considered as literal pixel values) and will override it if larger
1071+
`spaceH` | **minimum** horizontal spacing ratio, relative to the available width for each band, or a literal pixel value if **>= 1**;<br>this behaves exactly like [`barSpace`](#barspace-number) and the largest spacing (resulting from either `barSpace` or `spaceH`) will prevail.
10721072
10731073
The available canvas height is initially divided by `maxLeds` and vertical spacing is calculated observing the `spaceV` ratio;
10741074
if necessary, the led count is decreased until both the led segment and the vertical spacing are at least 2px tall.

0 commit comments

Comments
 (0)