diff --git a/_data/product_version.yml b/_data/product_version.yml index e6f4c7d..e072f57 100644 --- a/_data/product_version.yml +++ b/_data/product_version.yml @@ -1,7 +1,10 @@ useGroupedVersion: true version_info_list: - - value: latest version(3.0.3001) + - value: latest version(3.0.6000) + - value: 3.x + child: + - 3.0.3001 - value: 2.x child: - 2.6.1000 diff --git a/_includes/sidelist-programming/programming-js.html b/_includes/sidelist-programming/programming-js.html index 03c2fbb..88e33d1 100644 --- a/_includes/sidelist-programming/programming-js.html +++ b/_includes/sidelist-programming/programming-js.html @@ -1169,6 +1169,13 @@ >Edge +
  • + ErrorInfo +
  • BufferOverflowProtectionMode
  • CapturedResultItemType
  • ColourChannelUsageType
  • CornerType
  • CrossVerificationStatus
  • ErrorCode
  • GrayscaleEnhancementMode
  • GrayscaleTransformationMode
  • ImageFileFormat
  • ImagePixelFormat
  • ImageTagType
  • IntermediateResultUnitType
  • ModuleName
  • RegionObjectElementType
  • SectionType diff --git a/_includes/sidelist-programming/sidelist-parameters.html b/_includes/sidelist-programming/sidelist-parameters.html index 9c39d51..554f681 100644 --- a/_includes/sidelist-programming/sidelist-parameters.html +++ b/_includes/sidelist-programming/sidelist-parameters.html @@ -440,6 +440,8 @@
  • EnableQRCodeModel1
  • FindUnevenModuleBarcode
  • HeadModuleRatio
    • +
  • IncludeImpliedAI01
    • +
  • IncludeTrailingCheckDigit
  • MinQuietZoneWidth
  • MinRatioOfBarcodeZoneWidthToHeight
  • MinResultConfidence
    • diff --git a/assets/js/dcvWebVersionSearch.json b/assets/js/dcvWebVersionSearch.json index 9186da6..9bad315 100644 --- a/assets/js/dcvWebVersionSearch.json +++ b/assets/js/dcvWebVersionSearch.json @@ -1,4 +1,16 @@ [ + { + "version": "3.0.6000", + "matchVersion": { + "javascript": "11.0.6000" + } + }, + { + "version": "3.0.3001", + "matchVersion": { + "javascript": "11.0.3000" + } + }, { "version": "2.6.1000", "matchVersion": { diff --git a/programming/javascript/api-reference/core/basic-structures/captured-result-item-v3.0.3001.md b/programming/javascript/api-reference/core/basic-structures/captured-result-item-v3.0.3001.md new file mode 100644 index 0000000..284f979 --- /dev/null +++ b/programming/javascript/api-reference/core/basic-structures/captured-result-item-v3.0.3001.md @@ -0,0 +1,51 @@ +--- +layout: default-layout +title: Interface CapturedResultItem - Dynamsoft Core Module JS Edition API Reference +description: This page shows the JS edition of the interface CapturedResultItem in Dynamsoft Core Module. +keywords: captured result item, JS +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# CapturedResultItem + +The `CapturedResultItem` interface provides a common structure for representing different types of captured results. Each specific captured result item type will have its own implementation and additional properties specific to that type. + +> NOTE: +> +> Depending on the functional module that generated the result item, the interface may vary: +> +> * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html) +> * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html) +> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html), [DeskewedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/deksewed-image-result-item.html) or [EnhancedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/enhanced-image-result-item.html) +> * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html) + +```typescript +interface CapturedResultItem { + readonly type: EnumCapturedResultItemType; + readonly referencedItem: CapturedResultItem | null; + readonly targetROIDefName: string; + readonly taskName: string; +} +``` + +## type + +The type of the captured result item, indicating what kind of data it represents. + +**See Also** + +[EnumCapturedResultItemType]({{ site.dcvb_enums }}core/captured-result-item-type.html?lang=js) + +## referencedItem + +A property of type `CapturedResultItem` that represents a reference to another captured result item. + +## targetROIDefName + +The name of the target ROI definition which includes a task that generated the result. + +## taskName + +The name of the task that generated the result. diff --git a/programming/javascript/api-reference/core/basic-structures/captured-result-item.md b/programming/javascript/api-reference/core/basic-structures/captured-result-item.md index ec0e59e..3ff2935 100644 --- a/programming/javascript/api-reference/core/basic-structures/captured-result-item.md +++ b/programming/javascript/api-reference/core/basic-structures/captured-result-item.md @@ -18,13 +18,13 @@ The `CapturedResultItem` interface provides a common structure for representing > > * dynamsoft-barcode-reader: [BarcodeResultItem](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/barcode-result-item.html) > * dynamsoft-label-recognizer: [TextLineResultItem](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/textline-result-item.html) -> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html) or [NormalizedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/normalized-image-result-item.html) +> * dynamsoft-document-normalizer: [DetectedQuadResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quad-result-item.html), [DeskewedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/deksewed-image-result-item.html) or [EnhancedImageResultItem](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/enhanced-image-result-item.html) > * dynamsoft-code-parser: [ParsedResultItem](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result-item.html) ```typescript interface CapturedResultItem { readonly type: EnumCapturedResultItemType; - readonly referencedItem: CapturedResultItem | null; + readonly referenceItem: CapturedResultItem | null; readonly targetROIDefName: string; readonly taskName: string; } @@ -38,7 +38,7 @@ The type of the captured result item, indicating what kind of data it represents [EnumCapturedResultItemType]({{ site.dcvb_enums }}core/captured-result-item-type.html?lang=js) -## referencedItem +## referenceItem A property of type `CapturedResultItem` that represents a reference to another captured result item. diff --git a/programming/javascript/api-reference/core/basic-structures/error-info.md b/programming/javascript/api-reference/core/basic-structures/error-info.md new file mode 100644 index 0000000..cc76503 --- /dev/null +++ b/programming/javascript/api-reference/core/basic-structures/error-info.md @@ -0,0 +1,31 @@ +--- +layout: default-layout +title: Interface ErrorInfo - Dynamsoft Core Module JS Edition API Reference +description: This page shows the JS edition of the interface ErrorInfo in Dynamsoft Core Module. +keywords: error info, JS +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# ErrorInfo + +The `ErrorInfo` interface defines the structure for error objects returned by the `CaptureVisionRouter`. + +```typescript +interface ErrorInfo { + errorCode: EnumErrorCode; + errorString: string +} +``` + +## errorCode + +A predefined enumerated code that categorizes the type of error. This code is used programmatically to identify specific error conditions. + +**See Also** +[EnumErrorCode]({{ site.dcvb_js_api }}enums-error-code.html?lang=js) + +## errorString + +A human-readable message that describes the error. This message can be displayed to users or logged for debugging purposes. diff --git a/programming/javascript/api-reference/core/enum-error-code-v3.0.3001.md b/programming/javascript/api-reference/core/enum-error-code-v3.0.3001.md new file mode 100644 index 0000000..9cdd29f --- /dev/null +++ b/programming/javascript/api-reference/core/enum-error-code-v3.0.3001.md @@ -0,0 +1,258 @@ +--- +layout: default-layout +title: ErrorCode - Dynamsoft Core Enumerations +description: The enumeration ErrorCode of Dynamsoft Core describes all error codes. +keywords: Error code +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: ErrorCode +codeAutoHeight: true +--- + +# Enumeration ErrorCode + +`ErrorCode` enumerates the specific error codes that the SDK may return, providing a systematic way to identify and handle errors encountered during its operation. + +
    + >- JavaScript + > +> +```javascript +enum EnumErrorCode { + /** Operation completed successfully. */ + EC_OK = 0, + // Common error codes range from -10000 to -19999 + /** An unspecified error occurred. */ + EC_UNKNOWN = -10000, + /** The system does not have enough memory to perform the requested operation. */ + EC_NO_MEMORY = -10001, + /** A null pointer was encountered where a valid pointer was required. */ + EC_NULL_POINTER = -10002, + /** The provided license is not valid. */ + EC_LICENSE_INVALID = -10003, + /** The provided license has expired. */ + EC_LICENSE_EXPIRED = -10004, + /** The specified file could not be found. */ + EC_FILE_NOT_FOUND = -10005, + /** The file type is not supported for processing. */ + EC_FILE_TYPE_NOT_SUPPORTED = -10006, + /** The image's bits per pixel (BPP) is not supported. */ + EC_BPP_NOT_SUPPORTED = -10007, + /** The specified index is out of the valid range. */ + EC_INDEX_INVALID = -10008, + /** The specified custom region value is invalid or out of range. */ + EC_CUSTOM_REGION_INVALID = -10010, + /** Failed to read the image due to an error in accessing or interpreting the image data. */ + EC_IMAGE_READ_FAILED = -10012, + /** Failed to read a TIFF image, possibly due to corruption or unsupported format. */ + EC_TIFF_READ_FAILED = -10013, + /** The provided DIB (Device-Independent Bitmaps) buffer is invalid or corrupted. */ + EC_DIB_BUFFER_INVALID = -10018, + /** Failed to read a PDF image, possibly due to corruption or unsupported format. */ + EC_PDF_READ_FAILED = -10021, + /** Required PDF processing DLL is missing. */ + EC_PDF_DLL_MISSING = -10022, + /** The specified page number is invalid or out of bounds for the document. */ + EC_PAGE_NUMBER_INVALID = -10023, + /** The specified custom size is invalid or not supported. */ + EC_CUSTOM_SIZE_INVALID = -10024, + /** The operation timed out. */ + EC_TIMEOUT = -10026, + /** Failed to parse JSON input. */ + EC_JSON_PARSE_FAILED = -10030, + /** The JSON type is invalid for the expected context. */ + EC_JSON_TYPE_INVALID = -10031, + /** The JSON key is invalid or unrecognized in the current context. */ + EC_JSON_KEY_INVALID = -10032, + /** The JSON value is invalid for the specified key. */ + EC_JSON_VALUE_INVALID = -10033, + /** The required "Name" key is missing in the JSON data. */ + EC_JSON_NAME_KEY_MISSING = -10034, + /** The value of the "Name" key is duplicated and conflicts with existing data. */ + EC_JSON_NAME_VALUE_DUPLICATED = -10035, + /** The template name is invalid or does not match any known template. */ + EC_TEMPLATE_NAME_INVALID = -10036, + /** The reference made by the "Name" key is invalid or points to nonexistent data. */ + EC_JSON_NAME_REFERENCE_INVALID = -10037, + /** The parameter value provided is invalid or out of the expected range. */ + EC_PARAMETER_VALUE_INVALID = -10038, + /** The domain of the current site does not match the domain bound to the current product key. */ + EC_DOMAIN_NOT_MATCH = -10039, + /** The reserved information does not match the reserved info bound to the current product key. */ + EC_RESERVED_INFO_NOT_MATCH = -10040, + /** The license key does not match the license content. */ + EC_LICENSE_KEY_NOT_MATCH = -10043, + /** Failed to request the license content from the server. */ + EC_REQUEST_FAILED = -10044, + /** Failed to initialize the license. */ + EC_LICENSE_INIT_FAILED = -10045, + /** Error setting the mode's argument, indicating invalid or incompatible arguments. */ + EC_SET_MODE_ARGUMENT_ERROR = -10051, + /** The license content is invalid or corrupted. */ + EC_LICENSE_CONTENT_INVALID = -10052, + /** The license key is invalid or does not match any known valid keys. */ + EC_LICENSE_KEY_INVALID = -10053, + /** The license key has reached its maximum allowed usage and has no remaining quota. */ + EC_LICENSE_DEVICE_RUNS_OUT = -10054, + /** Failed to retrieve the mode's argument, possibly due to invalid state or configuration. */ + EC_GET_MODE_ARGUMENT_ERROR = -10055, + /** The Intermediate Result Types (IRT) license is invalid or not present. */ + EC_IRT_LICENSE_INVALID = -10056, + /** Failed to save the file, possibly due to permissions, space, or an invalid path. */ + EC_FILE_SAVE_FAILED = -10058, + /** The specified stage type is invalid or not supported in the current context. */ + EC_STAGE_TYPE_INVALID = -10059, + /** The specified image orientation is invalid or not supported. */ + EC_IMAGE_ORIENTATION_INVALID = -10060, + /** Failed to convert complex template to simplified settings, indicating a configuration or compatibility issue. */ + EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061, + /** Rejecting function call while capturing is in progress, to prevent conflicts or data corruption. */ + EC_CALL_REJECTED_WHEN_CAPTURING = -10062, + /** The specified image source was not found, indicating a missing or inaccessible input source. */ + EC_NO_IMAGE_SOURCE = -10063, + /** Failed to read the directory, possibly due to permissions, non-existence, or other access issues. */ + EC_READ_DIRECTORY_FAILED = -10064, + /** A required module (e.g., DynamsoftBarcodeReader, DynamsoftLabelRecognizer) was not found. */ + EC_MODULE_NOT_FOUND = -10065, + /** The api does not support multi-page files. Please use CaptureMultiPages instead. */ + EC_MULTI_PAGES_NOT_SUPPORTED = -10066, + /** Indicates an attempt to write to a file that already exists, with overwriting explicitly disabled. This error suggests the need for either enabling overwriting or ensuring unique file names to avoid conflicts. */ + EC_FILE_ALREADY_EXISTS = -10067, + /** The specified file path does not exist and could not be created. This error could be due to insufficient permissions, a read-only filesystem, or other environmental constraints preventing file creation. */ + EC_CREATE_FILE_FAILED = -10068, + /** The input ImageData object contains invalid parameters. This could be due to incorrect data types, out-of-range values, or improperly formatted data being passed to a function expecting ImageData. */ + EC_IMGAE_DATA_INVALID = -10069, + /** The size of the input image does not meet the requirements. */ + EC_IMAGE_SIZE_NOT_MATCH = -10070, + /** The pixel format of the input image does not meet the requirements. */ + EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071, + /** The section level result is irreplaceable. */ + EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072, + /** Incorrect axis definition. */ + EC_AXIS_DEFINITION_INCORRECT = -10073, + /**The result is not replaceable due to type mismatch*/ + EC_RESULT_TYPE_MISMATCH_IRREPLACEABLE = -10074, + /**Failed to load the PDF library.*/ + EC_PDF_LIBRARY_LOAD_FAILED = -10075, + /**The license is initialized successfully but detected invalid content in your key.*/ + EC_LICENSE_WARNING = -10076, + /**One or more unsupported JSON keys were encountered and ignored from the template.*/ + EC_UNSUPPORTED_JSON_KEY_WARNING = -10077, + /**Model file is not found*/ + EC_MODEL_FILE_NOT_FOUND = -10078, + /**[PDF] No license found.*/ + EC_PDF_LICENSE_NOT_FOUND = -10079, + /**The rectangle is invalid.*/ + EC_RECT_INVALID = -10080, + + // DLS license error codes range from -20000 to -29999 + /** Indicates no license is available or the license is not set. */ + EC_NO_LICENSE = -20000, + /** The provided Handshake Code is invalid or does not match expected format. */ + EC_HANDSHAKE_CODE_INVALID = -20001, + /** Encountered failures while attempting to read or write to the license buffer. */ + EC_LICENSE_BUFFER_FAILED = -20002, + /** Synchronization with the license server failed, possibly due to network issues or server unavailability. */ + EC_LICENSE_SYNC_FAILED = -20003, + /** The device attempting to use the license does not match the device specified in the license buffer. */ + EC_DEVICE_NOT_MATCH = -20004, + /** Binding the device to the license failed, indicating possible issues with the license or device identifier. */ + EC_BIND_DEVICE_FAILED = -20005, + /** The number of instances using the license exceeds the limit allowed by the license terms. */ + EC_INSTANCE_COUNT_OVER_LIMIT = -20008, + /** InitLicenseFromDLS must be called before any SDK objects are created to ensure proper license initialization. */ + EC_LICENSE_INIT_SEQUENCE_FAILED = -20009, + /** Indicates the license in use is a trial version with limited functionality or usage time. */ + EC_TRIAL_LICENSE = -20010, + /** The system failed to reach the License Server, likely due to network connectivity issues. */ + EC_FAILED_TO_REACH_DLS = -20200, + /** Online license validation failed due to network issues. Using cached license information for validation.*/ + EC_LICENSE_CACHE_USED = -20012, + + // DBR error codes range from -30000 to -39999 + /** The specified barcode format is invalid or unsupported. */ + EC_BARCODE_FORMAT_INVALID = -30009, + /** The license for decoding QR Codes is invalid or not present. */ + EC_QR_LICENSE_INVALID = -30016, + /** The license for decoding 1D barcodes is invalid or not present. */ + EC_1D_LICENSE_INVALID = -30017, + /** The license for decoding PDF417 barcodes is invalid or not present. */ + EC_PDF417_LICENSE_INVALID = -30019, + /** The license for decoding DataMatrix barcodes is invalid or not present. */ + EC_DATAMATRIX_LICENSE_INVALID = -30020, + /** The specified custom module size for barcode generation is invalid or outside acceptable limits. */ + EC_CUSTOM_MODULESIZE_INVALID = -30025, + /** The license for decoding Aztec barcodes is invalid or not present. */ + EC_AZTEC_LICENSE_INVALID = -30041, + /** The license for decoding Patchcode barcodes is invalid or not present. */ + EC_PATCHCODE_LICENSE_INVALID = -30046, + /** The license for decoding postal code formats is invalid or not present. */ + EC_POSTALCODE_LICENSE_INVALID = -30047, + /** The license for Direct Part Marking (DPM) decoding is invalid or not present. */ + EC_DPM_LICENSE_INVALID = -30048, + /** A frame decoding thread is already running, indicating a concurrent operation conflict. */ + EC_FRAME_DECODING_THREAD_EXISTS = -30049, + /** Stopping the frame decoding thread failed, indicating potential issues with thread management. */ + EC_STOP_DECODING_THREAD_FAILED = -30050, + /** The license for decoding MaxiCode barcodes is invalid or not present. */ + EC_MAXICODE_LICENSE_INVALID = -30057, + /** The license for decoding GS1 DataBar barcodes is invalid or not present. */ + EC_GS1_DATABAR_LICENSE_INVALID = -30058, + /** The license for decoding GS1 Composite codes is invalid or not present. */ + EC_GS1_COMPOSITE_LICENSE_INVALID = -30059, + /** The license for decoding DotCode barcodes is invalid or not present. */ + EC_DOTCODE_LICENSE_INVALID = -30061, + /** The license for decoding Pharmacode barcodes is invalid or not present. */ + EC_PHARMACODE_LICENSE_INVALID = -30062, + /** [Barcode Reader] No license found.*/ + EC_BARCODE_READER_LICENSE_NOT_FOUND = -30063, + + // DLR error codes range from -40000 to -49999 + /** Indicates that the required character model file was not found, possibly due to incorrect paths or missing files. */ + EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100, + /**There is a conflict in the layout of TextLineGroup. */ + EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101, + /**There is a conflict in the regex of TextLineGroup. */ + EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102, + /**[Label Recognizer] No license found.*/ + EC_LABEL_RECOGNIZER_LICENSE_NOT_FOUND = -40103, + + // DDN error codes range from -50000 to -59999 + /** The specified quadrilateral is invalid, potentially due to incorrect points or an unprocessable shape. */ + EC_QUADRILATERAL_INVALID = -50057, + /**[Document Normalizer] No license found.*/ + EC_DOCUMENT_NORMALIZER_LICENSE_NOT_FOUND = -50058, + + // Panorama error codes range from -70000 to -79999 + /** The license for generating or processing panoramas is invalid or missing. */ + EC_PANORAMA_LICENSE_INVALID = -70060, + // Reserved error codes range from -80000 to -89999 + + // DCP error codes range from -90000 to -99999 + /** The specified resource path does not exist, indicating a missing directory or incorrect path specification. */ + EC_RESOURCE_PATH_NOT_EXIST = -90001, + /** Failed to load the specified resource, which might be due to missing files, access rights, or other issues preventing loading. */ + EC_RESOURCE_LOAD_FAILED = -90002, + /** The code specification required for processing was not found, indicating a missing or incorrect specification. */ + EC_CODE_SPECIFICATION_NOT_FOUND = -90003, + /** The full code string provided is empty, indicating no data was provided for processing. */ + EC_FULL_CODE_EMPTY = -90004, + /** Preprocessing the full code string failed, possibly due to invalid format, corruption, or unsupported features. */ + EC_FULL_CODE_PREPROCESS_FAILED = -90005, + /** The license required for parsing South Africa Driver License data is invalid or not present. */ + EC_ZA_DL_LICENSE_INVALID = -90006, + /** The license required for parsing North America DL/ID (AAMVA) data is invalid or not present. */ + EC_AAMVA_DL_ID_LICENSE_INVALID = -90007, + /** The license required for parsing Aadhaar data is invalid or not present. */ + EC_AADHAAR_LICENSE_INVALID = -90008, + /** The license required for parsing Machine Readable Travel Documents (MRTD) is invalid or not present. */ + EC_MRTD_LICENSE_INVALID = -90009, + /** The license required for parsing Vehicle Identification Number (VIN) data is invalid or not present. */ + EC_VIN_LICENSE_INVALID = -90010, + /** The license required for parsing customized code types is invalid or not present. */ + EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011, + /**[Code Parser] No license found.*/ + EC_CODE_PARSER_LICENSE_NOT_FOUND = -90012 +} +``` \ No newline at end of file diff --git a/programming/javascript/api-reference/core/enum-error-code.md b/programming/javascript/api-reference/core/enum-error-code.md index 9cdd29f..dd29fe8 100644 --- a/programming/javascript/api-reference/core/enum-error-code.md +++ b/programming/javascript/api-reference/core/enum-error-code.md @@ -145,6 +145,8 @@ enum EnumErrorCode { EC_PDF_LICENSE_NOT_FOUND = -10079, /**The rectangle is invalid.*/ EC_RECT_INVALID = -10080, + /*The template version is incompatible. Please use a compatible template.*/ + EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081 // DLS license error codes range from -20000 to -29999 /** Indicates no license is available or the license is not set. */ @@ -169,6 +171,10 @@ enum EnumErrorCode { EC_FAILED_TO_REACH_DLS = -20200, /** Online license validation failed due to network issues. Using cached license information for validation.*/ EC_LICENSE_CACHE_USED = -20012, + /*License authentication failed: quota exceeded.*/ + EC_LICENSE_AUTH_QUOTA_EXCEEDED = -20013, + /**License restriction: the number of results has exceeded the allowed limit.*/ + EC_LICENSE_RESULTS_LIMIT_EXCEEDED = -20014, // DBR error codes range from -30000 to -39999 /** The specified barcode format is invalid or unsupported. */ diff --git a/programming/javascript/api-reference/index.md b/programming/javascript/api-reference/index.md index 9d92bb1..13063b1 100644 --- a/programming/javascript/api-reference/index.md +++ b/programming/javascript/api-reference/index.md @@ -187,6 +187,7 @@ breadcrumbText: API Reference * [Corner]({{ site.dcvb_js_api }}core/basic-structures/corner.html) * [DSRect]({{ site.dcvb_js_api }}core/basic-structures/ds-rect.html) * [Edge]({{ site.dcvb_js_api }}core/basic-structures/edge.html) +* [ErrorInfo]({{ site.dcvb_js_api }}core/basic-structures/error-info.html) * [LineSegment]({{ site.dcvb_js_api }}core/basic-structures/line-segment.html) * [Point]({{ site.dcvb_js_api }}core/basic-structures/point.html) * [Polygon]({{ site.dcvb_js_api }}core/basic-structures/polygon.html) diff --git a/programming/javascript/api-reference/utility/image-drawer.md b/programming/javascript/api-reference/utility/image-drawer.md index 7f57fe3..48e3479 100644 --- a/programming/javascript/api-reference/utility/image-drawer.md +++ b/programming/javascript/api-reference/utility/image-drawer.md @@ -30,6 +30,7 @@ class ImageDrawer { * @param type The type of drawing shapes. * @param color The color to use for drawing. Defaults to 0xFFFF0000 (red). * @param thickness The thickness of the lines to draw. Defaults to 1. + * @param name The name of the file, as a string, under which the image will be saved. * @param download An optional boolean flag that, when set to true, triggers the download of the file. * * @returns A promise that resolves with the saved File object. @@ -40,6 +41,7 @@ class ImageDrawer { type: "quads" | "lines" | "contours" | "corners" | "edges", color?: number, thickness?: number, + name: string, download?: boolean): Promise; } ``` @@ -56,6 +58,8 @@ class ImageDrawer { `thickness`: The thickness of the lines to draw. Defaults to 1. +`name`: The name of the file, as a string, under which the image will be saved. + `download`: An optional boolean flag that, when set to true, triggers the download of the file. **Return Value** diff --git a/programming/javascript/api-reference/utility/image-io.md b/programming/javascript/api-reference/utility/image-io.md index ece57e3..c285cf0 100644 --- a/programming/javascript/api-reference/utility/image-io.md +++ b/programming/javascript/api-reference/utility/image-io.md @@ -18,6 +18,8 @@ The `ImageIO` class provides APIs for images reading and saving. | [readFromFile()](#readfromfile) | Reads an image from a file | | [saveToMemory()](#savetomemory) | Saves an image to memory. | | [readFromMemory()](#readfrommemory) | Reads image data from memory using the specified ID. | +| [SaveToBase64String()](#savetobase64string) | Saves the specified image to a Base64-encoded string. | +| [ReadFromBase64String()](#readfrombase64string) | Reads an image from a Base64-encoded string | ## saveToFile @@ -91,4 +93,38 @@ readFromMemory(id: number) : Promise; **Return Value** -A Promise that resolves to the `DSImageData` object. \ No newline at end of file +A Promise that resolves to the `DSImageData` object. + +## SaveToBase64String + +This method saves an image to a Base64-encoded string. The desired file format is inferred from the 'format' parameter. Should the specified file format be omitted or unsupported, the data will default to being exported in PNG format. + +```typescript +SaveToBase64String: (image: Blob, format: Core.EnumImageFileFormat) => Promise; +``` + +**Parameters** + +`image`: The image to be saved, of type `Blob`. + +`format`: The desired image format. + +**Return Value** + +A promise that resolves with a Base64-encoded string representing the image. + +## ReadFromBase64String + +This method reads an image from a Base64-encoded string. The image format is automatically detected based on the content of the string. + +```typescript +ReadFromBase64String: (base64String: string) => Promise; +``` + +**Parameters** + +`base64String`: The Base64-encoded string representing the image. + +**Return Value** + +A promise that resolves with the loaded image of type `DSImageData`. \ No newline at end of file diff --git a/programming/javascript/api-reference/utility/image-processor.md b/programming/javascript/api-reference/utility/image-processor.md index d59895e..57b46d4 100644 --- a/programming/javascript/api-reference/utility/image-processor.md +++ b/programming/javascript/api-reference/utility/image-processor.md @@ -14,7 +14,8 @@ The `ImageProcessor` class provides APIs for processing images. | Name | Description | | ------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [cropImage()](#cropimage) | Crops an image using a rectangle or quadrilateral. | +| [cropImage()](#cropimage) | Crops an image using a rectangle. | +| [cropAndDeskewImage()](#cropanddeskewimage) | Crops and deskew an image using a quadrilateral. | | [adjustBrightness()](#adjustbrightness) | Adjusts the brightness of the image. | | [adjustContrast()](#adjustcontrast) | Adjusts the contrast of the image. | | [filterImage()](#filterimage) | Applies a specified image filter to an input image. | @@ -24,22 +25,40 @@ The `ImageProcessor` class provides APIs for processing images. ## cropImage -Crops an image using a rectangle or quadrilateral. +Crops an image using a rectangle. ```typescript -cropImage(image: Blob, roi: DSRect | Quadrilateral): Promise; +cropImage(image: Blob, roi: DSRect): Promise; ``` **Parameters** `image`: The image to be saved, of type `Blob`. -`roi`: The rectangle or quadrilateral to be cropped. +`roi`: The rectangle to be cropped. **Return Value** A promise that resolves with the cropped image data. +## cropAndDeskewImage + +Crops and deskews an image using a quadrilateral. + +```typescript +cropAndDeskewImage:(image: Blob, roi:Core.Quadrilateral) => Promise; +``` + +**Parameters** + +`image`: The image to be saved, of type `Blob`. + +`roi`: The quadrilateral defining the region of interest to be cropped and deskewed. + +**Return Value** + +A promise that resolves with the cropped and deskewed image data. + ## adjustBrightness Adjusts the brightness of the image. diff --git a/programming/javascript/release-notes/dcvb-3.md b/programming/javascript/release-notes/dcvb-3.md index 53abd02..8a3ed21 100644 --- a/programming/javascript/release-notes/dcvb-3.md +++ b/programming/javascript/release-notes/dcvb-3.md @@ -9,6 +9,27 @@ noTitleIndex: true # Release Notes - DynamsoftCaptureVisionBundle +## 3.0.6000(08/14/2025) + +### New + +- **Base64 String Conversion**: Enabled bidirectional conversion between `ImageData` and Base64 strings. + +- **Template Version Validation**: Introduced version checking for templates to prevent compatibility issues and mismatches. + +### Improved + +- **White-on-White Document Recognition**: Optimized accuracy for document detection in scenarios where white paper is placed on a white background. + +### Changed + +- **License Validation Behavior**: Instead of stopping execution immediately on an invalid license module, the library now continues processing and returns results from modules with valid licenses. An error is still reported to indicate the license issue. +- `StartCapturing` now stops immediately and returns a license-related error code if none of the tasks have a valid license, instead of proceeding and returning an empty result. + +### Fixed + +- Fixed various minor bugs and improved overall stability. + ## 3.0.3001(06/09/2025) ### Fixed diff --git a/programming/javascript/release-notes/index.md b/programming/javascript/release-notes/index.md index 60a3da4..360af15 100644 --- a/programming/javascript/release-notes/index.md +++ b/programming/javascript/release-notes/index.md @@ -9,6 +9,7 @@ noTitleIndex: true # Release Notes - Dynamsoft Capture Vision Bundle JavaScript +- [3.0.6000 (08/14/2025)](dcvb-3.md#306000-08142025) - [3.0.3001 (06/09/2025)](dcvb-3.md#303001-06092025) - [3.0.3000 (06/05/2025)](dcvb-3.md#303000-06052025) - [2.6.1000 (01/03/2025)](dcvb.md#261000-01032025)