From 8544f1dbb429ec121ffc5b22587c2e9754760705 Mon Sep 17 00:00:00 2001 From: lunaaaw <64242273+lunaaaw@users.noreply.github.com> Date: Thu, 11 May 2023 15:43:54 +0800 Subject: [PATCH 1/2] filter apis --- info/api/WebTwain_Acquire.md | 6 +++--- info/api/WebTwain_Util.md | 38 ++++++++++++++++++------------------ info/schedule/Stable.md | 8 ++++---- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/info/api/WebTwain_Acquire.md b/info/api/WebTwain_Acquire.md index c06de50c..ad9e0748 100644 --- a/info/api/WebTwain_Acquire.md +++ b/info/api/WebTwain_Acquire.md @@ -126,7 +126,7 @@ AcquireImage( **Parameters** -`deviceConfiguration`: Configuration for the acquisition. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration). +`deviceConfiguration`: Configuration for the acquisition. Please refer to [DeviceConfiguration]({{site.info}}api/Interfaces.html#DeviceConfiguration). `successCallback`: A callback function that is executed if the request succeeds. @@ -4695,7 +4695,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{ **Parameters** -`device`: the device object. Please refer to [Interface]({{site.info}}api/Interfaces.html#device). +`device`: the device object. Please refer to [Device]({{site.info}}api/Interfaces.html#device). **Availability** @@ -4737,7 +4737,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>; **Parameters** -`deviceConfiguration`: The device configuration. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration). +`deviceConfiguration`: The device configuration. Please refer to [DeviceConfiguration]({{site.info}}api/Interfaces.html#DeviceConfiguration). **Availability** diff --git a/info/api/WebTwain_Util.md b/info/api/WebTwain_Util.md index 68a4ce98..687ae391 100644 --- a/info/api/WebTwain_Util.md +++ b/info/api/WebTwain_Util.md @@ -33,7 +33,26 @@ The properties and methods on this page live in the namespace {WebTwainObject}. | [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) | | [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) | +
+ +
+ +>The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition. +**Methods** + +| | +| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| [`RegisterEvent()`]({{site.info}}api/WebTwain_Util.html#registerevent) | [`UnregisterEvent()`]({{site.info}}api/WebTwain_Util.html#unregisterevent) | [`GenerateURLForUploadData()`]({{site.info}}api/WebTwain_Util.html#generateurlforuploaddata) | + +**Properties** + +| | +| :------------------------------------ | :---------------------------- | ----------------------------- | ------------------------------- | +| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) | +| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) | + +
--- @@ -558,25 +577,6 @@ readonly VersionInfo: string; `Manufacturer` , `ProductFamily` , `ProductName` and `VersionInfo` together form the identity string of the Dynamic Web TWAIN library. -
- -
- ->The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition. -**Methods** - -| | -| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`RegisterEvent()`]({{site.info}}api/WebTwain_Util.html#registerevent) | [`UnregisterEvent()`]({{site.info}}api/WebTwain_Util.html#unregisterevent) | [`GenerateURLForUploadData()`]({{site.info}}api/WebTwain_Util.html#generateurlforuploaddata) | - -**Properties** - -| | -| :------------------------------------ | :---------------------------- | ----------------------------- | ------------------------------- | -| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) | -| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) | - -
\ No newline at end of file diff --git a/info/schedule/Stable.md b/info/schedule/Stable.md index 3945dbdb..f9b3864c 100644 --- a/info/schedule/Stable.md +++ b/info/schedule/Stable.md @@ -25,18 +25,18 @@ permalink: /info/schedule/Stable.html - Expanded the capabilities of the Android platform. See the APIs supported on Android service. #### Remote Scan -- The remote scan solution powered by Dynamic Web TWAIN is now officially available. With it, you can turn any of your tranditional document scanners into a network-able scanner and allow your end users to use it without installing anything on the client device. Read this documentation to learn how the Remote Scan solution works. +- The Remote Scan solution powered by Dynamic Web TWAIN is now officially available. Using Remote Scan, you can turn any of your traditional document scanners into a network accessible scanner and allow your end users to use it without any client side installs. Read this documentation to learn how the Remote Scan solution works. ### Improvements #### Image Viewer -- The Viewer component has been migrated to a dedicated resource file. This will allow for viewerless implementations of Dynamic Web TWAIN to reduce the load by removing the necessity of loading the Viewer resources into memory even when the Viewer is not being used. See the property [Dynamsoft.DWT.UseDefaultViewer]({{site.info}}api/Dynamsoft_WebTwainEnv.html#usedefaultviewer). -- Added the enum [EnumDWT_WorkMode]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_workmode) with a new option for image editor setting, please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor). +- The Viewer component has been migrated to a dedicated resource file. This will allow for viewerless implementations of Dynamic Web TWAIN, as well as reducing the load on the browser by removing the necessity of loading the Viewer resources into memory when the Viewer is not being used. See the property [Dynamsoft.DWT.UseDefaultViewer]({{site.info}}api/Dynamsoft_WebTwainEnv.html#usedefaultviewer). +- Added the enum [EnumDWT_WorkMode]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_workmode) with a new option for image editor setting. Please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor). - Added new method `save()` to the ImageEditor object, please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor). #### Optimized error handling during web twain initialization -- Added an [OnWebTwainError]({{site.info}}api/Dynamsoft_WebTwainEnv.html#onwebtwainerror) event for better capturing errors during the web twain object initialization. +- Added the [OnWebTwainError]({{site.info}}api/Dynamsoft_WebTwainEnv.html#onwebtwainerror) event for better capturing errors during the Web Twain object initialization. #### General Improvements - Updated the barcode reader library to v9.6.20 From 430a8a0790ee0d74cee541f9ce5db2300dfe3210 Mon Sep 17 00:00:00 2001 From: lunaaaw <64242273+lunaaaw@users.noreply.github.com> Date: Thu, 11 May 2023 15:46:36 +0800 Subject: [PATCH 2/2] Update interfaces.md --- info/api/interfaces.md | 50 ++++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/info/api/interfaces.md b/info/api/interfaces.md index b1dd918e..f4a79504 100644 --- a/info/api/interfaces.md +++ b/info/api/interfaces.md @@ -11,8 +11,8 @@ permalink: /info/api/interfaces.html # Interfaces | | -| :----- | -| [`Device`](#device) | +|:-|:-| +| [`Device`](#device) | [`DeviceConfiguration`](#DeviceConfiguration) | --- @@ -31,25 +31,27 @@ interface Device{ } ``` -**Availability** -
- - - - - - - - - - - - - - - - - - -
ActiveXH5(Windows)H5(macOS/TWAIN)H5(macOS/ICA)H5(Linux)
not supportedv18.0+v18.0+v18.0+v18.0+
-
+--- + +## DeviceConfiguration + +**Syntax** + +```typescript +interface DeviceConfiguration { + IfShowUI?: boolean; //Whether to show the built-in User Interface from the device vendor + PixelType?: Dynamsoft.DWT.EnumDWT_PixelType | number | string; //Whether to scan in color, grey or black & white + Resolution?: number; //Measured by dots per pixel (DPI) + IfFeederEnabled?: boolean; //Whether to use the document feeder or the flatbed of the device + IfDuplexEnabled?: boolean; //Whether to scan one side or both sides + IfDisableSourceAfterAcquire?: boolean; //Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true. + IfGetImageInfo?: boolean; //Whether to retrieve information about the image after it's transferred. + IfGetExtImageInfo?: boolean; //Whether to retrieve extended information about the image after it's transferred. + extendedImageInfoQueryLevel?: Dynamsoft.DWT.EnumDWT_ExtImageInfo | number; //How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true. + SelectSourceByIndex?: number; //Specify a source by its index. + IfCloseSourceAfterAcquire?: boolean; //Whether to close the data source after aquisition. Default: false. + PageSize?: Dynamsoft.DWT.EnumDWT_CapSupportedSizes | number; //Specify page size +} +``` + +---