Skip to content

Jackson branch #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ztyyLV merged 2 commits into from
May 10, 2023
Merged

Jackson branch #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25aedb7
Merge pull request #636 from dynamsoft-docs/luna-18.2
rebeccakak May 9, 2023
4e59936
update
ztyyLV May 10, 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
21 changes: 3 additions & 18 deletions info/api/WebTwain_Acquire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,26 +92,11 @@ AcquireImage(
successCallBack?: () => void,
failureCallBack?: (deviceConfiguration?: DeviceConfiguration, errorCode: number, errorString: string) => void
): void;

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
}
```

**Parameters**

`deviceConfiguration`: Configuration for the acquisition.
`deviceConfiguration`: Configuration for the acquisition. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration).

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

Expand Down Expand Up @@ -4680,7 +4665,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{

**Parameters**

`device`: the device object. Please refer to [Device]({{site.info}}api/Interfaces.html#device)
`device`: the device object. Please refer to [Interface]({{site.info}}api/Interfaces.html#device).

**Availability**

Expand Down Expand Up @@ -4722,7 +4707,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;

**Parameters**

`deviceConfiguration`: The device configuration
`deviceConfiguration`: The device configuration. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration).

**Availability**

Expand Down
47 changes: 25 additions & 22 deletions info/api/interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ permalink: /info/api/interfaces.html
| |
| :----- |
| [`Device`](#device) |
| [`DeviceConfiguration`](#DeviceConfiguration) |

---

Expand All @@ -31,25 +32,27 @@ interface Device{
}
```

**Availability**
<div class="availability">
<table>

<tr>
<td align="center">ActiveX</td>
<td align="center">H5(Windows)</td>
<td align="center">H5(macOS/TWAIN)</td>
<td align="center">H5(macOS/ICA)</td>
<td align="center">H5(Linux)</td>
</tr>

<tr>
<td align="center">not supported</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
<td align="center">v18.0+</td>
</tr>

</table>
</div>
---

## 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
}
```

---