Merge pull request #532 from dynamsoft-docs/preview

Preview

Author: lunaaaw

info/api/Addon_PDF.md

@@ -278,58 +278,58 @@ interface PDFWSettings {
     /**
      * Specify the author.
      */
-    author: string;
+    author?: string;
     /**
      * Specify the compression type.
      */
-    compression: Dynamsoft.DWT.EnumDWT_PDFCompressionType | number;
+    compression?: Dynamsoft.DWT.EnumDWT_PDFCompressionType | number;
      /**
      * Specify the page type.
      * Allowed values are 0: Original, 2: A4, 6: letter, 8: legal
      */
-    pageType: number; 
+    pageType?: number; 
     /**
      * Specify the creator.
      */
-    creator: string;
+    creator?: string;
     /**
      * Specify the creation date.
      * Note that the argument should start with 'D:' like 'D:20181231'.
      */
-    creationDate: string;
+    creationDate?: string;
     /**
      * Specify the key words.
      */
-    keyWords: string;
+    keyWords?: string;
     /**
      * Specify the modified date.
      * Note that the argument should start with 'D:' like 'D:20181231'.
      */
-    modifiedDate: string;
+    modifiedDate?: string;
     /**
      * Specify the producer.
      */
-    producer: string;
+    producer?: string;
     /**
      * Specify the subject.
      */
-    subject: string;
+    subject?: string;
     /**
      * Specify the title.
      */
-    title: string;
+    title?: string;
     /**
      * Specify the PDF version. For example, 1.5. The allowed values are 1.1 ~ 1.7.
      * NOTE: If the compression type is PDF_JBig2, the lowerest version is 1.4
      * If the compression type is PDF_JP2000, the lowerest version is 1.5
      */
-    version: number;
+    version?: string;
     /**
      * Specify the quality of the images in the file.
      * The value ranges from 0 to 100.
      * Only valid when the {compression} is 'JPEG' or 'JPEG2000'.
      */
-    quality: number;
+    quality?: number;
 }
 ```
 

info/api/Dynamsoft_WebTwainEnv.md

@@ -202,7 +202,6 @@ interface DWTInitialConfig {
         Host ? : string,
         Port ? : string,
         PortSSL ? : string,
-        UseLocalService? : boolean
 }
 ```
 

info/api/WebTwain_Acquire.md

@@ -597,7 +597,7 @@ OpenSourceAsync(): Promise<boolean>;
  * Return all available data sources (scanners, etc.) and optionally all detailed information about them.
  * @param bIncludeDetails Whether to return more details about the data sources or just their names.
  */
-GetSourceNames(bIncludeDetails: boolean): string[] | SourceDetails[];
+GetSourceNames(bIncludeDetails?: boolean): string[] | SourceDetails[];
 
 interface SourceDetails {
     /**
@@ -4204,23 +4204,23 @@ interface CapabilityDetails {
     /**
      * The container type of the Capability
      */
-    conType: ValueAndLabel;
+    conType?: ValueAndLabel;
     /**
      * The index for the current value of the Capability
      */
-    curIndex: number;
+    curIndex?: number;
     /**
      * The current value of the Capability
      */
-    curValue: ValueAndLabel;
+    curValue?: ValueAndLabel;
     /**
      * The index for the default value of the Capability
      */
-    defIndex: number;
+    defIndex?: number;
     /**
      * The operation types that are supported by the Capability. Types include {"get", "set", "reset" "getdefault", "getcurrent"}
      */
-    query: string[];
+    query?: string[];
     /**
      * The value type of the Capability. Value types include
         TWTY_BOOL: 6
@@ -4237,22 +4237,22 @@ interface CapabilityDetails {
         TWTY_UINT16: 4
         TWTY_int: 5
      */
-    valueType: ValueAndLabel;
+    valueType?: ValueAndLabel;
     /**
      * The available values of the Capability
      */
-    values: ValueAndLabel[];
+    values?: ValueAndLabel[];
 }
 
 interface ValueAndLabel {
     /**
      * Numeric representation of the item
      */
-    value: Dynamsoft.DWT.EnumDWT_Cap | Dynamsoft.DWT.EnumDWT_CapType | Dynamsoft.DWT.EnumDWT_CapValueType | number;
+    value?: Dynamsoft.DWT.EnumDWT_Cap | Dynamsoft.DWT.EnumDWT_CapType | Dynamsoft.DWT.EnumDWT_CapValueType | number;
     /**
      * Label or name of the item
      */
-    label: string;
+    label?: string;
 }
 ```
 

info/api/WebTwain_IO.md

@@ -3588,6 +3588,30 @@ Print(useOSPrintWindow ? : boolean): boolean;
 
 `useOSPrintWindow`: Whether to use the print feature of the operating system instead.
 
+**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">v6.0+ </td>
+<td align="center">v10.0+ </td>
+<td align="center">v11.0+ </td>
+<td align="center">v11.0+ </td>
+<td align="center">v12.1+ </td>
+</tr>
+
+</table>
+</div>
+
 **Usage Notes**
 
 The parameter only works in Windows Service mode.

info/api/WebTwain_Viewer.md

@@ -172,12 +172,12 @@ DWObject.Viewer.clearSelectedAreas();
  * Generate an independent CustomElement object.
  * @param element Specify the HTMLDivElement.
  * @param location Define where to place the custom element. The allowed values are "left" and "right", and the default value is "right".
- * @param bCover The default value is `false`, that is, the created CustomElement is displayed according to the set area. If set to true, the main viewer will be covered by the CustomElement.
+ * @param ifFull The default value is `false`, that is, the created CustomElement is displayed according to the set area. If set to true, the main viewer will be covered by the CustomElement.
  */
 createCustomElement(
     element: HTMLDivElement,
     location?: string,
-    bCover?: boolean
+    ifFull?: boolean
 ): CustomElement;
 
 interface CustomElement {
@@ -193,6 +193,10 @@ interface CustomElement {
      * Remove the custom element.
      */
     dispose(): boolean;
+    /**
+     * Return the created element.
+     */
+    element?: any;
 };
 ```
 
@@ -573,7 +577,7 @@ interface ThumbnailViewerSettings {
      */
     autoChangeIndex?: boolean;
     checkbox?: {
-      visibility?: string; //"visible":hidden", default: "hidden" 
+      visibility?: string; //"visible":hidden", default: "hidden"
       width?: number | string; //default: "24px",number unit: px, string value: "24px"/"10%", relative to parent container
       height?: number | string; //default: "24px",number unit: px, string value: "24px"/"10%", relative to parent container
       background?: string; //default: "#ffffff"
@@ -591,7 +595,7 @@ interface ThumbnailViewerSettings {
       translateY?: number | string //default: "",  number unit: px, string value: "10px"/"10%", relative to itself
     };
     pageNumber?: {
-      visibility?: string; //"visible": hidden", default: "hidden" 
+      visibility?: string; //"visible": hidden", default: "hidden"
       width?: number | string; //default: "24px", number unit: px, string value: "24px"/"10%", relative to parent container
       height?: number | string; //default: "24px", number unit: px, string value: "24px"/"10%", relative to parent container
       background?: string; //default: "#ffffff"            
@@ -622,16 +626,16 @@ interface ViewMode {
     /**
      * Specify the number of images per row.
      */
-    columns: number;
+    columns?: number;
     /**
      * Specify the number of images per column.
      */
-    rows: number;
+    rows?: number;
     /**
      * Set or return whether the pages are arranged vertically or horizontally.
      * Default: "vertical". Allowed values are "vertical" and "horizontal".
      */
-    scrollDirection: string;
+    scrollDirection?: string;
 }
 ```
 ```typescript