Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion error.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default-layout
title: Error Page - Dynamsoft Barcode Reader SDK Documentation
keywords: dynamsoft barcode reader, dbr, documentation, error page
description: Dynamsoft Barcode Reader SDK Documentation Errorpage
description: Dynamsoft Barcode Reader SDK Documentation Error page
---

<div id="main">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ moduleSize: number;

## details

Represent additional details specific to the barcode, which could vary depending on the barcode format.
Represents additional details specific to the barcode, which could vary depending on the barcode format.

```typescript
details: BarcodeDetails;
Expand Down Expand Up @@ -153,4 +153,4 @@ eciSegments: Array<ECISegment>;

**Remarks**

New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ bytes: Array<number>;

## details

Represent additional details specific to the barcode, which could vary depending on the barcode format.
Represents additional details specific to the barcode, which could vary depending on the barcode format.

```typescript
details: BarcodeDetails;
Expand Down Expand Up @@ -152,4 +152,4 @@ eciSegments: Array<ECISegment>;

**Remarks**

New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ length: number;

**Remarks**

New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
layout: default-layout
title: interface ScaleBarcodeImageUnit - Dynamsoft Barcode Reader Module JS Edition API Reference
description: This page shows the JS edition of the interface ScaleBarcodeImageUnit in Dynamsoft Barcode Reader Module.
title: interface ScaledBarcodeImageUnit - Dynamsoft Barcode Reader Module JS Edition API Reference
description: This page shows the JS edition of the interface ScaledBarcodeImageUnit in Dynamsoft Barcode Reader Module.
keywords: scaled, Image unit, JS
needAutoGenerateSidebar: true
noTitleIndex: true
---

# ScaleBarcodeImageUnit
# ScaledBarcodeImageUnit

A unit of data that contains scaled barcode image. It extends the `IntermediateResultUnit` interface.

```typescript
interface ScaleBarcodeImageUnit extends Core.IntermediateResultUnit {
interface ScaledBarcodeImageUnit extends Core.IntermediateResultUnit {
imageData: Core.DSImageData;
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ grayscaleEnhancementModes: Array<Dynamsoft.Core.EnumGrayscaleEnhancementMode>;

## localizationModes

Set the location modes with an array of enumeration `LocalizationMode`. View the reference page of `LocalizationModes` for more detail about location modes.
Set the localization modes with an array of enumeration `LocalizationMode`. View the reference page of `LocalizationModes` for more detail about localization modes.

```typescript
localizationModes: Array<EnumLocalizationMode>;
Expand Down
3 changes: 1 addition & 2 deletions programming/javascript/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ breadcrumbText: Release Notes
- [9.6.11 (03/13/2023)](js-9.html#9611-03132023)
- [9.6.10 (02/21/2023)](js-9.html#9610-02212023)
- [9.6.2 (01/16/2023)](js-9.html#962-01162023)
- [9.6.2 (01/16/2023)](js-9.html#962-01162023)
- [9.6.1 (12/19/2022)](js-9.html#961-12192022)
- [9.6.0 (12/13/2022)](js-9.html#960-12132022)
- [9.3.1 (10/10/2022)](js-9.html#931-10102022)
Expand Down Expand Up @@ -77,4 +76,4 @@ breadcrumbText: Release Notes
- [6.4.1 (12/11/2018)](js-7.html#641-12112018)
- [6.3.0 (08/16/2018)](js-7.html#630-08162018)
- [5.2.0 (09/18/2017)](js-7.html#520-09182017)
- [5.1.0 (05/25/2017)](js-7.html#510-05252017)
- [5.1.0 (05/25/2017)](js-7.html#510-05252017)
15 changes: 5 additions & 10 deletions programming/javascript/release-notes/js-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,14 @@ permalink: /programming/javascript/release-notes/js-10.html

### New

- Introduced [BarcodeScanner](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html) class
- Introduced the [BarcodeScanner](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html) class
- Offers high-level APIs that provide core functionalities
- Includes pre-built UI for fast and seamless integration
- Features intuitive configuration objects to simplify both algorithm and UI setup

<p align="center">
<img src="../user-guide/assets/barcodeScanner_single_mode.png" alt="multiple" width="35%" style="margin-right: 50px;"/>
<img src="../user-guide/assets/barcodeScanner_multiple_mode.png" alt="multiple" width="35%"/>
</p>

### Improved

- Merged resource files previously required by the Barcode-Reader-Bundle, significantly reduced the overall size of the `.wasm` file
- Merged resource files previously required by the Barcode-Reader-Bundle, significantly reducing the overall size of the `.wasm` file

## 10.4.3100 (01/03/2025)

Expand Down Expand Up @@ -155,22 +150,22 @@ permalink: /programming/javascript/release-notes/js-10.html
- Changed the logic of the `capturedResultItemTypes` setting of [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_js_api }}capture-vision-router/interfaces/simplified-capture-vision-settings.html):
- If the result item types don't match the specified template, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types do not match the task configurations in the template".
- Based on the `capturedResultItemTypes` setting, the irrelevant tasks will be removed from the template.
- The `capturedResultItemTypes` should include at least one of the `CRIT_BARCODE`, `CRIT_TEXT_LINE`, `CRIT_DETECTED_QUAD`, `CRIT_NORMALIZED_IMAGE`. Otherwise, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types should contain at least one task result type".
- The `capturedResultItemTypes` should include at least one of the `CRIT_BAR_CODE`, `CRIT_TEXT_LINE`, `CRIT_DETECTED_QUAD`, `CRIT_NORMALIZED_IMAGE`. Otherwise, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types should contain at least one task result type".
- Refactored the [`Contour`]({{ site.dcvb_js_api }}core/basic-structures/contour.html) interface. Please view API reference - `Contour` interface for more information.

## 10.0.21 (02/05/2024)

#### Improved

- Introduced `dbr.bundle.js` to include packages that are required on running Dynamsoft Barcode Reader to reduce the complexity of the code.
- Introduced `dbr.bundle.js` to include packages that are required to run Dynamsoft Barcode Reader to reduce the complexity of the code.

## 10.0.20 (01/29/2024)

### Changelog

In this version, the SDK has been refactored under the `DynamsoftCaptureVision` (DCV) architecture. To learn more about the architecture, please see [Architecture of Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/architecture/). The following highlights the major changes:

* The class `BarcodeReader` and `BarcodeScanner` are removed and its functionalities are now incorporated into the newly added Class `CaptureVisionRouter`.
* The class `BarcodeReader` and `BarcodeScanner` were removed and their functionalities are now incorporated into the newly added Class `CaptureVisionRouter`.

* License-related functions are handled by class [Dynamsoft.License.LicenseManager]({{ site.dcvb_js_api }}license/license-manager.html#initLicense).

Expand Down
10 changes: 4 additions & 6 deletions programming/javascript/release-notes/js-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Updated third-party libraries to incorporate the latest security fixes.
- Fixed an issue where coordinate conversion could behave abnormally after large images were compressed.
- Fixed an issue where abnormal DCEFrame `imageData` could cause errors in the `toCanvas()` method.

### improved
### Improved

- Optimized the behavior of the Dynamsoft Camera Enhancer torch and other camera-related features.

Expand Down Expand Up @@ -154,7 +154,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and
#### Engineering Optimizations

- Optimized the parallel download logic to improve resource loading speed.
- Optimized [adaptive WASM loading logic](../faq/adaptive-wasm-loading.md) to further enhance performance in modern browser environments.
- Optimized [adaptive WASM loading logic](https://www.dynamsoft.com/faq/barcode-reader/web/capabilities/adaptive-wasm-loading.html) to further enhance performance in modern browser environments.

### API Changes

Expand Down Expand Up @@ -193,7 +193,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and
- Introduced new samples:

- [`Pick One to Fill`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/scenarios/pick-one-to-fill/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/pick-one-to-fill/index.html?utm_source=sampleReadme): Pick one and auto-fill fields by simply opening the camera and scanning a group of barcodes.
- [`Batch Inventory`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/scenarios/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scan barcodes in batches and provide real-time analysis of the scanned data.
- [`Batch Inventory`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/scenarios/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scans barcodes in batches and provides real-time analysis of the scanned data.
- [`Read and Parse GS1-AI`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/scenarios/read-and-parse-GS1-AI/scan-using-rtu-api/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/read-and-parse-GS1-AI/scan-using-rtu-api/index.html?utm_source=sampleReadme): Read GS1 Application Identifier (AI) barcode and parse its structured data.

- Template Version Validation: Introduced version checking for templates to prevent compatibility issues and mismatches.
Expand Down Expand Up @@ -233,9 +233,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and

- Added several new UI controls (not displayed by default).

<img src="../user-guide/assets/1103000_new_control_components.png" style="display: block; margin: 0 auto;"/>

- Introduced a new `"Scan and Search"` sample to simulate searching for relevant data via barcodes. [Give it a try!](https://demo.dynamsoft.com/Samples/DBR/JS/scenarios/scan-and-search/scan-and-search.html)
- Introduced a new `"Scan and Search"` sample to simulate searching for relevant data via barcodes. [Give it a try!](https://demo.dynamsoft.com/Samples/DBR/JS/scenarios/scan-and-search/index.html)

<img src="../user-guide/assets/scan_and_search_sample.png" width="80%" style="display: block; margin: 0 auto;"/>

Expand Down
2 changes: 1 addition & 1 deletion programming/javascript/release-notes/js-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ permalink: /programming/javascript/release-notes/js-7.html

### IMPROVED

- The method decodebuffer now uses the pixel format IPF_ABGR_8888 by default.
- The method decodeBuffer now uses the pixel format IPF_ABGR_8888 by default.
- Enhanced deformation resistance for QR.
- Optimized the algorithm for reading large-size dense QR and DataMatrix.
- Optimized the algorithm for 1D barcode deblurring.
Expand Down
12 changes: 6 additions & 6 deletions programming/javascript/release-notes/js-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ permalink: /programming/javascript/release-notes/js-8.html
## 8.8.7 (01/26/2022)

* Added the attribute `muted` to the video embed element so that the video can be played without user interaction.
* Fixed a bug with the property `intervalTime` in `ScanSettings` to avoid unnecesary frame fetching actions.
* Fixed a bug with the property `intervalTime` in `ScanSettings` to avoid unnecessary frame fetching actions.

## 8.8.5 (01/26/2022)

Expand All @@ -36,7 +36,7 @@ permalink: /programming/javascript/release-notes/js-8.html
<div class="fold-panel-start"></div>

* Added a new localization mode `ONED_FAST_SCAN`, which significantly improved the localization speed for 1D barcodes.
* Added the ability to specify barcode `width`, `height`, `angle` to improve the recognition speed if you have advance information about barcodes.
* Added the ability to specify barcode `width`, `height`, `angle` to improve the recognition speed if you have advanced information about barcodes.
* Optimized the logic of `confidence` scoring for 2D barcodes. The 2D barcode results with confidence greater than 30 are more accurate.

<div class="fold-panel-end"></div>
Expand All @@ -62,7 +62,7 @@ The class names of the built-in UI elements have changed
| `dbrScanner-bg-camera` | `dce-bg-camera` |
| `dbrScanner-video` | `dce-video` |
| `dbrScanner-sel-camera` | `dce-sel-camera` |
| `dbrScanner-sel-resolutio` | `dce-sel-resolution` |
| `dbrScanner-sel-resolution` | `dce-sel-resolution` |
| `dbrScanner-btn-close` | `dce-btn-close` |

## 8.6.3 (09/30/2021)
Expand Down Expand Up @@ -244,7 +244,7 @@ Please note that these APIs still exist under `Dynamsoft.DBR.BarcodeReader` , bu

### Fixed

* Fixed a bug where `barcodeFormatString`, `barcodeFormatString_2`, `regionName` and `documentName` don't have value in the `IRT_TYPED_BARCODE_ZONE` intermediate result.
* Fixed a bug where `barcodeFormatString`, `barcodeFormatString_2`, `regionName` and `documentName` don't have value in the `IRT_TYPED_BAR_CODE_ZONE` intermediate result.

## 8.1.0 (01/19/2021)

Expand Down Expand Up @@ -279,13 +279,13 @@ Please note that these APIs still exist under `Dynamsoft.DBR.BarcodeReader` , bu
### New

* Added support for decoding barcodes from an existing video stream.
* Introduced new namespace `Dynamsoft. DBR`.
* Introduced new namespace `Dynamsoft.DBR`.
* Implemented a new licensing tracking mechanism, License 2.0, which makes it easier for users to track license usage.
* Added a new format control parameter, BarcodeZoneMinDistanceToImageBorders, to set the minimum distance (in pixels) between the barcode zone and image borders.
* Added a new format control parameter, MinRatioOfBarcodeZoneWidthToHeight, to set the minimum ratio (width/height) of the barcode zone.
* Added a new format control parameter, BarcodeZoneBarCountRangeArray, to set the barcode zone's range of bar count for barcode search.
* Added a new argument, SpatialIndexBlockSize, for RPM_GENERAL_RGB_CONTRAST, RPM_GENERAL_GRAY_CONTRAST and RPM_GENERAL_HSV_CONTRAST.
* Added a new parameter, DeblurModes, so users can use different deblur algorithms for different scenarios. DeblurModes has the following enum types: DirectBinarization, ThresholdBinarization, GrayEqulization, Smoothing, Morphing, DeepAnalysis and Sharpening.
* Added a new parameter, DeblurModes, so users can use different deblur algorithms for different scenarios. DeblurModes has the following enum types: DirectBinarization, ThresholdBinarization, GrayEqualization, Smoothing, Morphing, DeepAnalysis and Sharpening.

### Improved

Expand Down
9 changes: 4 additions & 5 deletions programming/javascript/release-notes/js-9.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ permalink: /programming/javascript/release-notes/js-9.html
- Updated the internal `Dynamsoft Camera Enhancer` to [v3.3.1](https://www.dynamsoft.com/camera-enhancer/docs-archive/web/programming/javascript/release-note/release-notes-3.x.html#331-02202023).
- The method `decodeBuffer` is updated to accept an additional parameter "orientation" to help specify the orientation of the image data.
- The interface `LocalizationResult` is updated to have a new property "transformationMatrix".
- Three missing errorcodes are added: DBR_PANORAMA_LICENSE_INVALID, DBR_PHARMACODE_LICENSE_INVALID, DBR_IMAGE_ORIENTATION_INVALID. Check the full list at [`EnumErrorCode`](https://www.dynamsoft.com/barcode-reader/docs/v9/web/programming/javascript/api-reference/enum/EnumErrorCode.html).
- Three missing error codes are added: DBR_PANORAMA_LICENSE_INVALID, DBR_PHARMACODE_LICENSE_INVALID, DBR_IMAGE_ORIENTATION_INVALID. Check the full list at [`EnumErrorCode`](https://www.dynamsoft.com/barcode-reader/docs/v9/web/programming/javascript/api-reference/enum/EnumErrorCode.html).

#### Fixed

Expand Down Expand Up @@ -158,7 +158,7 @@ permalink: /programming/javascript/release-notes/js-9.html
2. `autoFocus`, when set to `true`, means the SDK will automatically focus on the part of the video where a barcode is found but fails to be read;
3. `autoSuggestTip`, when set to `true`, means the SDK will automatically suggest Tip messages to help guide the user to acquire better video frames for barcode reading.

> These features are only valid when there is a intermediate_results module license.
> These features are only valid when there is an intermediate_results module license.

#### Changed

Expand Down Expand Up @@ -244,7 +244,7 @@ permalink: /programming/javascript/release-notes/js-9.html

* Added method `setVideoFit()` to `BarcodeScanner` to allow the video element to either fit or cover the viewer.
* Added method `setImageSource()` to `BarcodeReader` to specify an Image Source which provides images of the type `DSImage` for continuous scanning.
* Added methods `startScanning()`, `pauseScanning()`, `resumeScanning()`, `stopScanning()`, `getScanSettings()` and `updateScanSettings()` as well as events `onUniqueRead` and `onImageRead` to `BarcodeReader` to facilitate continous scanning of images coming from the Image Source.
* Added methods `startScanning()`, `pauseScanning()`, `resumeScanning()`, `stopScanning()`, `getScanSettings()` and `updateScanSettings()` as well as events `onUniqueRead` and `onImageRead` to `BarcodeReader` to facilitate continuous scanning of images coming from the Image Source.

## 9.0.0 (03/24/2022)

Expand All @@ -256,7 +256,7 @@ permalink: /programming/javascript/release-notes/js-9.html

* Simplified the license activation steps. Different license activation APIs are integrated into one API.
* Added support for **Pharmacode**.
* Added support for **Code 11**, an 1D format.
* Added support for **Code 11**, a 1D format.
* Deformation resisting modes `DRM_BROAD_WARP`, `DRM_LOCAL_REFERENCE` and `DRM_DEWRINKLE` are optimized and detached from `DRM_GENERAL`. Users can specify a more effective deformation resisting mode when processing **QRCode** and **DataMatrix codes**.
* Optimized the confidence scoring system for **PDF417 codes**.

Expand All @@ -275,7 +275,6 @@ permalink: /programming/javascript/release-notes/js-9.html
* The file **dbr.scanner.html** has been renamed to **dbr.ui.html**.
* `dbrScanner-cvs-scanarea` class is now renamed to `dce-scanarea`
* `dce-video` is now replaced by `dce-video-container`
* `dbrScanner-scanlight` is now replaced by `dce-scanlight`
* `dbrScanner-cvs-drawarea` has been removed

The following APIs are renamed:
Expand Down
4 changes: 2 additions & 2 deletions programming/javascript/user-guide/explore-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ While the SDK has been carefully tuned to provide the best possible performance
* [Read barcodes with uneven lighting]({{site.features}}read-barcodes-with-uneven-lighting.html?lang=js)
* [Read images with texture]({{site.features}}read-images-with-texture.html?lang=js)
* [Read images with lots of text]({{site.features}}read-images-with-lots-of-text.html?lang=js)
* [Preprocesss images to read difficult barcodes]({{site.features}}preprocess-images.html?lang=js)
* [Preprocess images to read difficult barcodes]({{site.features}}preprocess-images.html?lang=js)

## Barcode Results

* [Get barcode confidence and rotation]({{site.features}}get-confidence-rotation.html?lang=js)
* [Get barcode location]({{site.features}}get-barcode-location.html?lang=js)
* [Get detailed barcode information]({{site.features}}get-detailed-info.html?lang=js)
* [Filter and sort decoding results]({{site.features}}filter-and-sort.html?lang=js)
<!-- * [Use intermediate results]({{site.features}}use-intermidiate-results.html?lang=js) -->
<!-- * [Use intermediate results]({{site.features}}use-intermediate-results.html?lang=js) -->

## Advanced Features

Expand Down
Loading