Skip to content
Merged

v18.2 #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
141fa1f
Update Dynamsoft_WebTwainEnv.md
ztyyLV Apr 19, 2023
ef841ce
Merge pull request #613 from ztyyLV/Jackson-branch
ztyyLV Apr 19, 2023
d91ece9
Update general-troubleshooting-steps.md
kyle-ds Apr 19, 2023
9629c0e
Merge pull request #614 from dynamsoft-docs/kyle-ds-patch-1
kyle-ds Apr 19, 2023
ddaf737
preview
kyle-ds Apr 26, 2023
e05b3bc
preview
kyle-ds Apr 26, 2023
6109ce7
preview
kyle-ds Apr 26, 2023
3f312c7
saving
kyle-ds Apr 26, 2023
37bc52c
1
kyle-ds Apr 26, 2023
af5979e
1
kyle-ds Apr 26, 2023
f10d5e0
1
kyle-ds Apr 27, 2023
7a2bd74
Add Android to IO
kyle-ds Apr 27, 2023
46d9f44
Fix incorrect deprecation
kyle-ds Apr 28, 2023
6550a00
API Update
kyle-ds Apr 28, 2023
ae920bf
post review update. missing viewer class updates
kyle-ds Apr 28, 2023
f8ef674
restore callbacks to WebTwainEnv
kyle-ds Apr 28, 2023
b8ba3c2
Merge pull request #617 from dynamsoft-docs/kyle-18.2
kyle-ds Apr 28, 2023
9fe79fe
Merge remote-tracking branch 'origin/preview' into kyle-18.2
kyle-ds Apr 28, 2023
1b1d8c1
Update Stable.md
chloe-dynamsoft May 4, 2023
3face6c
Merge branch 'preview' of https://github.com/dynamsoft-docs/web-twain…
kyle-ds May 5, 2023
53299b8
RN update
kyle-ds May 5, 2023
3f0af65
Merge branch 'kyle-18.2' of https://github.com/dynamsoft-docs/web-twa…
kyle-ds May 5, 2023
d6ba35f
Merge pull request #618 from dynamsoft-docs:kyle-18.2
kyle-ds May 5, 2023
b1b0215
remove deprecations
kyle-ds May 5, 2023
2ab63c0
Merge pull request #619 from dynamsoft-docs:kyle-18.2
kyle-ds May 5, 2023
ec8bc67
luna-18.2-1
lunaaaw May 6, 2023
e10ac77
Merge pull request #620 from dynamsoft-docs/luna-18.2
lunaaaw May 6, 2023
e7085ec
add new error list
lunaaaw May 6, 2023
3f0c43d
Merge pull request #621 from dynamsoft-docs/luna-18.2
lunaaaw May 6, 2023
147cea5
Update appendix.md
lunaaaw May 6, 2023
af66e49
Merge pull request #622 from dynamsoft-docs/luna-18.2
lunaaaw May 6, 2023
e268e6b
Update WebTwain_Viewer.md
lunaaaw May 6, 2023
a9e6eef
Merge pull request #623 from dynamsoft-docs/luna-18.2
lunaaaw May 6, 2023
3605999
Update WebTwain_Viewer.md
lunaaaw May 6, 2023
112a81b
Merge pull request #624 from dynamsoft-docs/luna-18.2
lunaaaw May 6, 2023
2a6b6eb
RN
lunaaaw May 9, 2023
53c97ec
Update version-list.html
lunaaaw May 9, 2023
adadd92
Merge pull request #626 from dynamsoft-docs/luna-18.2
lunaaaw May 9, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _data/full_tree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ tree_list:
path: /info/api/Dynamsoft_Enum.html
- name: Interfaces
path: /info/api/Interfaces.html
- name: Device
path: /info/api/Device.html
#- name: Device
# path: /info/api/Device.html
- name: WebTwain_Scanner
path: /info/api/WebTwain_Acquire.html
- name: WebTwain_Buffer
Expand Down
3 changes: 2 additions & 1 deletion _includes/version-list.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<span class="fullVersionHistory">
<ul class="fullVersionInfo">
<li onclick="changeVersion(this)">Latest Version (18.1)</li>
<li onclick="changeVersion(this)">Latest Version (18.2)</li>
<li onclick="changeVersion(this)">Version 18.1</li>
<li onclick="changeVersion(this)">Version 18.0</li>
<li onclick="changeVersion(this)">Version 17.3</li>
<li onclick="changeVersion(this)">Version 17.2.1</li>
Expand Down
6 changes: 3 additions & 3 deletions faq/general-troubleshooting-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ permalink: /faq/general-troubleshooting-steps.html
- Linux, `/opt/dynamsoft/DynamsoftService/log`

2. Set the log level
- For only one client machine, go to the application with Dynamic Web TWAIN integrated, press F12 to open the development tools, switch to "console" tab and enter the command "DWObject.LogLevel = 1" to enable the debugger mode.
- For all client machines, set [ `LogLevel` ]({{site.info}}api/WebTwain_Util.html#loglevel) to 1 in your code. This property should be set as soon as the `WebTwain` instance is created. For example, in the event `Dynamsoft_OnReady`
Option A - Single client machine troubleshooting - go to the application with Dynamic Web TWAIN integrated, press F12 to open the development tools, switch to "console" tab and enter the command "DWObject.LogLevel = 1" to enable the debugger mode.
Option B - For all client machines (application wide) - set [ `LogLevel` ]({{site.info}}api/WebTwain_Util.html#loglevel) to 1 in your code. This property should be set as soon as the `WebTwain` instance is created. For example, in the event `Dynamsoft_OnReady`
```javascript
function Dynamsoft_OnReady() {
DWObject = Dynamsoft.DWT.GetWebTwain("dwtcontrolContainer");
Expand All @@ -41,4 +41,4 @@ permalink: /faq/general-troubleshooting-steps.html
- On macOS, the log files are in `Go > Applications > Dynamsoft > DynamsoftServicex64_17 > {installed version No.} > log`
- On Linux, the log files are in `/opt/dynamsoft/DynamsoftServicex64_17/log`

5. Set log level back to the default value (0) to disable the debugger mode, otherwise the operation speed will be affected.
5. Set log level back to the default value (0) to disable the debugger mode, otherwise the operation speed will be affected.
15 changes: 12 additions & 3 deletions info/api/Dynamsoft_Enum.md
Original file line number Diff line number Diff line change
Expand Up @@ -876,17 +876,26 @@ Note: IT_MULTIPAGE_PDF & IT_MULTIPAGE_TIF are only applicable to the ImageType o
| Label | Value|
|:-|:-|
| TWAINSCANNER | 0x10 |
| WIATWAINSCANNER | 0x20 |
| WIASCANNER | 0x20 |
| TWAINX64SCANNER | 0x40 |
| ICASCANNER | 0x80 |
| SANESCANNER | 0x100 |
| ESCLSCANNER | 0x200 |
| WIFIDIRECTSCANNER | 0x400 |
| WIATWAINSCANNER | 0x800 |


## `Dynamsoft.DWT.EnumDWT_ExtImageInfo`

| Label | Value|
| Label | Value |
|:-|:-|
| default | 0 |
| standard | 1 |
| supported | 2 |
| supported | 2 |

## `Dynamsoft.DWT.EnumDWT_WorkMode`

| Label | Value | Description |
|:-|:-|:-|
| Normal | 0 | Original mode, the image data is processed in the buffer |
| Balance | 1 | The image data is processed in the browser canvas |
40 changes: 30 additions & 10 deletions info/api/Dynamsoft_WebTwainEnv.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,8 @@ interface Dynamsoft.DWT {
GetWebTwainEx(WebTwainId: string): WebTwain;
Load(): void;
Unload(): void;
RemoveAllAuthorizations: function () {};
OnWebTwainNotFound: function () {};
OnWebTwainPostExecute: function () {};
OnWebTwainPreExecute: function () {};
OnWebTwainReady: function () {};
OnWebTwainWillInit: function () {};
}

/**
Expand Down Expand Up @@ -226,20 +222,16 @@ interface DWTInitialConfig {
Initiates the library. If there are predefined `Containers` , one `WebTwain` instance will be created for each `Container` .

### `RegisterEvent()`

[We removed OnWebTWainReady...]: #
Registers an environmental event. Typically the event is `OnWebTwainReady` which is triggered when the initialization completes.

### `Unload()`

Destroys all `WebTwain` instances and cuts off the connection to the Dynamsoft Service.

### `RemoveAllAuthorizations()`

Removes the specific authorizations made by end users on a client machine. Only effective when the security feature is enabled for local files, scanners or cameras.

### `UseDefaultViewer`

Whether to use the built-in viewer. If it is set to `false` , the file `dynamsoft.viewer.js` is not loaded at all and there is no way to add it back later. Therefore, only set it to `false` when you absolutely won't need the viewer or will be building your own viewer.
Whether to use the built-in viewer. If it is set to `false` , the file `dynamsoft.webtwain.viewer.js` is not loaded at all and there is no way to add it back later. Therefore, only set it to `false` when you absolutely won't need the viewer or will be building your own viewer.

### `CustomizableDisplayInfo`

Expand Down Expand Up @@ -272,3 +264,31 @@ Specify the source of the loader bar image. Check out more on [HTMLImageElement.
#### `loaderBarClassName`

Specify the class name of the DIV element that contains the loader bar. With this class, you can customize the loader bar even further with CSS.

#### `OnWebTwainReady`

A built-in callback triggered when the Web TWAIN resources have completed loading

**Example**
```javascript
Dynamsoft.DWT.RegisterEvent('OnWebTwainReady',
Dynamsoft_OnReady //The typical function for initalizing the environment once the resources have loaded
);
```

#### `OnWebTwainError`

A built-in callback triggered when an error is detected when laoding the Web TWAIN environment

**Example**
```javascript
Dynamsoft.DWT.RegisterEvent('OnWebTwainError',
Dynamsoft_OnError
);


function Dynamsoft_OnError(error){
// error handling
console.error(error.message);
}
```
20 changes: 18 additions & 2 deletions info/api/WebTwain_Acquire.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@ CloseSourceAsync(): Promise<boolean>;
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -385,6 +386,7 @@ CloseSourceAsync(): Promise<boolean>;
<td align="center">v16.1+</td>
<td align="center">v16.1+</td>
<td align="center">v16.1+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -831,6 +833,7 @@ SelectSourceAsync(deviceType?: Dynamsoft.DWT.EnumDWT_DeviceType | number): Promi
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -839,6 +842,7 @@ SelectSourceAsync(deviceType?: Dynamsoft.DWT.EnumDWT_DeviceType | number): Promi
<td align="center">v16.1+</td>
<td align="center">v16.1+</td>
<td align="center">v16.1+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -4159,6 +4163,7 @@ RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {});
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4167,6 +4172,7 @@ RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {});
<td align="center">v15.1+</td>
<td align="center">v15.1+</td>
<td align="center">v15.1+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -4427,6 +4433,7 @@ interface ValueAndLabel {
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4435,6 +4442,7 @@ interface ValueAndLabel {
<td align="center">v16.0+</td>
<td align="center">v16.0+</td>
<td align="center">v16.0+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -4494,7 +4502,7 @@ interface CapabilitySetup {

**Parameters**

`capabilities`: A object that describes how to set capabilities.
`capabilities`: An object that describes how to set capabilities.

`successCallback`: A callback function that is executed if the request succeeds.

Expand All @@ -4512,6 +4520,7 @@ interface CapabilitySetup {
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4520,6 +4529,7 @@ interface CapabilitySetup {
<td align="center">v16.0+</td>
<td align="center">v16.0+</td>
<td align="center">v16.0+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -4616,6 +4626,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4624,14 +4635,15 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.2+</td>
</tr>

</table>
</div>

**Remark**

[Device APIs]({{site.info}}api/Device.html)
Interface [Device]({{site.info}}api/Interfaces.html#device)

---

Expand Down Expand Up @@ -4672,6 +4684,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4680,6 +4693,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down Expand Up @@ -4712,6 +4726,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
<td align="center">Android Service</td>
</tr>

<tr>
Expand All @@ -4720,6 +4735,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.2+</td>
</tr>

</table>
Expand Down
Loading