diff --git a/_config.yml b/_config.yml index ce02b36..7476da3 100644 --- a/_config.yml +++ b/_config.yml @@ -4,6 +4,8 @@ docFullPath: https://www.dynamsoft.com/code-parser/docs/web firstLevelUrl: /code-parser/docs/web/ docRootName: "Code Parser JS Edition" docHomePage: /code-parser/docs/core/introduction/ +needSearchIndex: true +searchNeedFilter: true js: /code-parser/docs/web/programming/javascript/ dcp_js_api: /code-parser/docs/web/programming/javascript/api-reference/ diff --git a/programming/javascript/api-reference/enum-mapping-status.md b/programming/javascript/api-reference/enum-mapping-status.md new file mode 100644 index 0000000..f6ce7e6 --- /dev/null +++ b/programming/javascript/api-reference/enum-mapping-status.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +title: MappingStatus - Dynamsoft Code Parser Enumerations +description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field. +keywords: Mapping status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: MappingStatus +--- + +# Enumeration MappingStatus + +`MappingStatus` represents the outcome of a mapping operation on a field. + +
+ >- JavaScript + > +> +```javascript +enum EnumMappingStatus { + /** + * Indicates that no mapping operation has been initiated. + */ + MS_NONE = 0, + /** + * Indicates that the mapping operation was successfully completed. + */ + MS_SUCCEEDED = 1, + /** + * Indicates that the mapping operation failed to complete. + */ + MS_FAILED = 2 +} +``` \ No newline at end of file diff --git a/programming/javascript/api-reference/enum-validation-status.md b/programming/javascript/api-reference/enum-validation-status.md new file mode 100644 index 0000000..605536a --- /dev/null +++ b/programming/javascript/api-reference/enum-validation-status.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +title: ValidationStatus - Dynamsoft Code Parser Enumerations +description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field. +keywords: Validation status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: ValidationStatus +--- + +# Enumeration ValidationStatus + +`ValidationStatus` describes the outcome of a validation process on a field. + +
+ >- JavaScript + > +> +```javascript +enum EnumValidationStatus { + /** + * Indicates that no validation has been performed. + */ + VS_NONE = 0, + /** + * Indicates that the validation process was completed successfully. + */ + VS_SUCCEEDED = 1, + /** + * Indicates that the validation process failed. + */ + VS_FAILED = 2 +} +``` \ No newline at end of file diff --git a/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md b/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md new file mode 100644 index 0000000..d20da7f --- /dev/null +++ b/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md @@ -0,0 +1,75 @@ +--- +layout: default-layout +title: ParsedResult - Dynamsoft Code Parser JavaScript Interface +description: This page shows the ParsedResult interface of Dynamsoft Code Parser for JavaScript. +keywords: ParsedResult, javascript, interface +needAutoGenerateSidebar: false +noTitleIndex: true +breadcrumbText: ParsedResult +--- + +# ParsedResult + +The ParsedResult interface provides a structure representing the result object returned by Dynamsoft Code Parser. + +```ts +interface ParsedResult { + originalImageHashId: string; + originalImageTag: Core.ImageTag; + parsedResultItems: Array; + hasItem: (item: ParsedResultItem) => boolean; + removeItem: (item: ParsedResultItem) => void; + errorCode: number; + errorString: string; +} +``` + + + +## originalImageHashId + +Returns the hash id of the original image. + +```ts +originalImageHashId: string; +``` + +## originalImageTag + +Returns the tag of the original image. + +```ts +originalImageTag: Core.ImageTag; +``` + +**See Also** + +* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html) + +## parsedResultItems + +Returns an array that contains all `ParsedResultItem`s. + +## hasItem() + +Checks whether the specified `ParsedResultItem` exists. + +## removeItem() + +Removes the specified `ParsedResultItem`. + +## errorCode + +Returns the error code for the parsing operation. + +## errorString + +Returns the error string that corresponds with `errorCode`. diff --git a/programming/javascript/api-reference/interfaces/parsed-result.md b/programming/javascript/api-reference/interfaces/parsed-result.md index d20da7f..ec853a3 100644 --- a/programming/javascript/api-reference/interfaces/parsed-result.md +++ b/programming/javascript/api-reference/interfaces/parsed-result.md @@ -14,13 +14,9 @@ The ParsedResult interface provides a structure representing the result object r ```ts interface ParsedResult { - originalImageHashId: string; - originalImageTag: Core.ImageTag; parsedResultItems: Array; hasItem: (item: ParsedResultItem) => boolean; removeItem: (item: ParsedResultItem) => void; - errorCode: number; - errorString: string; } ``` @@ -34,26 +30,6 @@ interface ParsedResult { | [errorCode](#errorcode) | Returns the error code for the parsing operation. | | [errorString](#errorstring) | Returns the error string that corresponds with `errorCode`. | --> -## originalImageHashId - -Returns the hash id of the original image. - -```ts -originalImageHashId: string; -``` - -## originalImageTag - -Returns the tag of the original image. - -```ts -originalImageTag: Core.ImageTag; -``` - -**See Also** - -* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html) - ## parsedResultItems Returns an array that contains all `ParsedResultItem`s. @@ -64,12 +40,4 @@ Checks whether the specified `ParsedResultItem` exists. ## removeItem() -Removes the specified `ParsedResultItem`. - -## errorCode - -Returns the error code for the parsing operation. - -## errorString - -Returns the error string that corresponds with `errorCode`. +Removes the specified `ParsedResultItem`. \ No newline at end of file