Awesome

capacitor-plugin-dynamsoft-document-normalizer

A document scanning plugin for Capacitor using Dynamsoft Document Normalizer.

Online demo

Versions

For Capacitor v6, use versions >= 3.0.

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

For Capacitor v4, use v0.x.

SDK Versions Used for Different Platforms

Supported Platforms

• Web
• Android
• iOS

Install

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

API

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

initialize()

initialize() => Promise<void>

initLicense(...)

initLicense(options: { license: string; }) => Promise<void>

initRuntimeSettingsFromString(...)

initRuntimeSettingsFromString(options: { template: string; }) => Promise<void>

detect(...)

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

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

detectBitmap(...)

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.

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

normalize(...)

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

Returns: <code>Promise<{ result: <a href="#normalizedimageresult">NormalizedImageResult</a>; }></code>

detectAndNormalize(...)

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

Returns: <code>Promise<{ result: <a href="#normalizedimageresult">NormalizedImageResult</a>; }></code>

setEngineResourcePaths(...)

setEngineResourcePaths(options: { paths: any; }) => Promise<void>

Web Only

Interfaces

DetectedQuadResultItem

Quadrilateral

Point

NormalizedImageResult