UnknownObject/quaggaJS
1
0
Fork 0
mirror of https://github.com/serratus/quaggaJS.git synced 2026-08-13 05:31:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add multiple to docs

Browse Source 
May need to go into more detail since the result object is significantly different.
This commit is contained in:
dgreif
2016-02-08 09:41:06 -06:00
parent afeb37be35
commit a1ded4b3e7
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -1
View File
@@ -357,7 +357,8 @@ options within the `decoder` are for debugging/visualization purposes only.
showPattern: false, showPattern: false,
readers: [ readers: [
'code_128_reader' 'code_128_reader'
] ],
multiple: false
} }
``` ```
@@ -380,6 +381,10 @@ more possible clashes, or false-positives. One should take care of the order
the readers are given, since some might return a value even though it is not the readers are given, since some might return a value even though it is not
the correct type (EAN-13 vs. UPC-A). the correct type (EAN-13 vs. UPC-A).
The `multiple` property tells the decoder if it should stop after finding a single result. If multiple is set to
`true`, the `result` object will have a `barcodes` array, each of which is a `result` object with it's own `codeResult`,
`box`, `line`, etc.
The remaining properties `drawBoundingBox`, `showFrequency`, `drawScanline` and The remaining properties `drawBoundingBox`, `showFrequency`, `drawScanline` and
`showPattern` are mostly of interest during debugging and visualization. `showPattern` are mostly of interest during debugging and visualization.