capacitor-plugin-dynamsoft-document-normalizer

A document scanning plugin for Capacitor using Dynamsoft Document Normalizer.

Online demo

Versions

For Capacitor v7, use versions >= 4.x.

For Capacitor v6, use versions 3.x.

For Capacitor v5, use versions 1.x and 2.x.

For Capacitor v4, use v0.x.

SDK Versions Used for Different Platforms

| Product | Android | iOS | Web |
| ----------- | ----------- | ----------- | ------- |
| Dynamsoft Capture Vision | 3.x | 3.x | 3.x |

Supported Platforms

* Web
* Android
* iOS

Install

``bash
npm install capacitor-plugin-dynamsoft-document-normalizer
npx cap sync
`

API

* initialize()
* initLicense(...)
* initRuntimeSettingsFromString(...)
* detect(...)
* detectBitmap(...)
* normalize(...)
* detectAndNormalize(...)
* setEngineResourcePaths(...)
* Interfaces
* Enums

$3

`typescript
initialize() => Promise
`

--------------------

$3

`typescript
initLicense(options: { license: string; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------- |
| options | { license: string; } |

--------------------

$3

`typescript
initRuntimeSettingsFromString(options: { template: string; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------- |
| options | { template: string; } |

--------------------

$3

`typescript
detect(options: { path?: string; source?: string | HTMLImageElement | HTMLCanvasElement; template?: string; }) => Promise<{ results: DetectedQuadResultItem[]; }>
`

source: Android and iOS only support base64 string.
path: for Android and iOS.
template: pass a template name to specify the template

| Param | Type |
| ------------- | ---------------------------------------------------------------- |
| options | { path?: string; source?: any; template?: string; } |

Returns: Promise<{ results: DetectedQuadResultItem[]; }>

--------------------

$3

`typescript
detectBitmap(options: { className?: string; methodName?: string; template?: string; }) => Promise<{ results: DetectedQuadResultItem[]; }>
`

Android and iOS only method which directly reads camera frames from capacitor-plugin-camera. Pass a template name to specify the template.

| Param | Type |
| ------------- | ---------------------------------------------------------------------------- |
| options | { className?: string; methodName?: string; template?: string; } |

Returns: Promise<{ results: DetectedQuadResultItem[]; }>

--------------------

$3

`typescript
normalize(options: { path?: string; source?: string | HTMLImageElement | HTMLCanvasElement; quad: Quadrilateral; template?: string; saveToFile?: boolean; includeBase64?: boolean; }) => Promise<{ result: NormalizedImageResult; }>
`

source: Android and iOS only support base64 string.
path: for Android and iOS.
template: pass a template name to specify the template

| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | { path?: string; source?: any; quad: Quadrilateral; template?: string; saveToFile?: boolean; includeBase64?: boolean; } |

Returns: Promise<{ result: NormalizedImageResult; }>

--------------------

$3

`typescript
detectAndNormalize(options: { path?: string; source?: string | HTMLImageElement | HTMLCanvasElement; template?: string; saveToFile?: boolean; includeBase64?: boolean; }) => Promise<{ result: NormalizedImageResult; }>
`

source: Android and iOS only support base64 string.
path: for Android and iOS.
template: pass a template name to specify the template

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| options | { path?: string; source?: any; template?: string; saveToFile?: boolean; includeBase64?: boolean; } |

Returns: Promise<{ result: NormalizedImageResult; }>

--------------------

$3

`typescript
setEngineResourcePaths(options: { paths: any; }) => Promise
`

Web Only

| Param | Type |
| ------------- | ---------------------------- |
| options | { paths: any; } |

--------------------

$3


#### DetectedQuadResultItem

| Prop | Type | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| location | Quadrilateral | The location of the detected quadrilateral within the original image, represented as a quadrilateral shape. |
| confidenceAsDocumentBoundary | number | A confidence score related to the detected quadrilateral's accuracy as a document boundary. |
| CrossVerificationStatus | EnumCrossVerificationStatus | Indicates whether the DetectedQuadResultItem has passed corss verification. |


#### Quadrilateral

| Prop | Type | Description |
| ------------------ | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| points | [Point, Point, Point, Point] | An array of four Point objects defining the vertices of the quadrilateral. |
| boundingRect | DSRect | The bounding rectangle of the quadrilateral, represented by a DSRect object. |
| area | number | The area of the quadrilateral. |


#### Point

| Prop | Type | Description |
| ------- | ------------------- | ------------------------------ |
| x | number | The x-coordinate of the point. |
| y | number | The y-coordinate of the point. |


#### DSRect

| Prop | Type | Description |
| ---------------------------- | -------------------- | ------------------------------------------------------------- |
| left | number | The left coordinate of the rectangle. |
| right | number | The right coordinate of the rectangle. |
| top | number | The top coordinate of the rectangle. |
| bottom | number | The bottom coordinate of the rectangle. |
| isMeasuredInPercentage | boolean | Indicates if the rectangle's measurements are in percentages. |


#### NormalizedImageResult

| Prop | Type |
| ------------ | ------------------- |
| base64 | string |
| path | string |

$3


#### EnumCrossVerificationStatus

| Members | Value | Description |
| ---------------------- | -------------- | ---------------------------------------------------- |
| CVS_NOT_VERIFIED | 0 | The cross verification has not been performed yet. |
| CVS_PASSED | 1 | The cross verification has been passed successfully. |
| CVS_FAILED` | 2 | The cross verification has failed. |