dwt 18.3.0 → 18.4.0

package/dist/types/WebTwain.Edit.d.ts

@@ -3,6 +3,7 @@ import { WebTwainBuffer } from "./WebTwain.Buffer";
 
 export interface WebTwainEdit extends WebTwainBuffer {
     /**
+	 * @deprecated since version 16.2. This function will be removed in future versions. Use `Viewer.createImageEditor` instead.
      * Show the built-in image editor. If called without any arguments while the editor is open, it'll close the editor.
      * @param divId Specify a div element to hold the editor.
      * @param width Specify the width of the editor.
@@ -353,8 +354,8 @@ export interface WebTwainEdit extends WebTwainBuffer {
      */
     BackgroundFillColor: number;
     /**
-     * [Deprecation] Add text on an image.
-     * [Alternative] Annotation feature to be added in a later version.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Annotation feature to be added in a later version.
+     * Add text on an image.
      * @param index  the index of the image that you want to add text to.
      * @param x the x coordinate for the text.
      * @param y the y coordinate for the text.
@@ -375,8 +376,8 @@ export interface WebTwainEdit extends WebTwainBuffer {
         backgroundOpacity: number
     ): boolean;
     /**
-     * [Deprecation] Create the font for adding text using the method AddText.
-     * [Alternative] Annotation feature to be added in a later version.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Annotation feature to be added in a later version.
+     * Create the font for adding text using the method AddText.
      * @param height Specifies the desired height (in logical units) of the font.
      * The absolute value of nHeight must not exceed 16,384 device units after it is converted.
      * For all height comparisons, the font mapper looks for the largest font that does not
@@ -430,8 +431,8 @@ export interface WebTwainEdit extends WebTwainBuffer {
         faceName: string
     ): boolean;
     /**
-     * [Deprecation] Decorates image of a specified index in buffer with rectangles of transparent color.
-     * [Alternative] Annotation feature to be added in a later version.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Annotation feature to be added in a later version.
+     * Decorates image of a specified index in buffer with rectangles of transparent color.
      * @param index specifies the index of image in buffer. The index is 0-based.
      * @param left Specify the rectangle (leftmost coordinate).
      * @param top Specify the rectangle (topmost coordinate).

package/dist/types/WebTwain.IO.d.ts

@@ -24,11 +24,13 @@ export interface WebTwainIO extends WebTwainUtil {
      */
     HttpFieldNameOfUploadedImage: string;
     /**
-     * [Deprecation] Return or set the password used to log into the HTTP server.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * Return or set the password used to log into the HTTP server.
      */
     HTTPPassword: string;
     /**
-     * [Deprecation] Return or set the user name used to log into the HTTP server.
+     * @deprecated since version 10.1. This property will be removed in future versions. 
+     * Return or set the user name used to log into the HTTP server.
      */
     HTTPUserName: string;
     /**
@@ -73,42 +75,52 @@ export interface WebTwainIO extends WebTwainUtil {
      */
     TIFFCompressionType: DynamsoftEnumsDWT.EnumDWT_TIFFCompressionType | number;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the name of the person who creates the PDF document.
      */
     PDFAuthor: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the compression type of PDF files. This is a runtime property.
      */
     PDFCompressionType: DynamsoftEnumsDWT.EnumDWT_PDFCompressionType | number;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the date when the PDF document is created.
      */
     PDFCreationDate: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the name of the application that created the original document, if the PDF document is converted from another form.
      */
     PDFCreator: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the keywords associated with the PDF document.
      */
     PDFKeywords: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the date when the PDF document is last modified.
      */
     PDFModifiedDate: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the name of the application that converted the PDF document from its native.
      */
     PDFProducer: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the subject of the PDF document.
      */
     PDFSubject: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the title of the PDF document.
      */
     PDFTitle: string;
     /**
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `PDF.Write.Setup` instead.
      * Return or set the value of the PDF version.
      */
     PDFVersion: string;
@@ -348,6 +360,7 @@ export interface WebTwainIO extends WebTwainUtil {
             errorString: string) => void
     ): void;
     /**
+	 * @deprecated since version 10.1. This function will be removed in future versions. Use `HTTPDownload` or `HTTPDownloadEx` instead.
      * Download the specified file via a HTTP Post request.
      * @param host The HTTP Host.
      * @param path Specify the path of the file to download.
@@ -432,6 +445,7 @@ export interface WebTwainIO extends WebTwainUtil {
             response: string) => void
     ): void;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions.
      * Upload the specified image via a HTTP Put request.
      * @param host The HTTP Host.
      * @param index Specify the image.
@@ -685,7 +699,8 @@ export interface WebTwainIO extends WebTwainUtil {
             errorString: string) => void
     ): void | boolean;
     /**
-     * [Deprecation] Return or set how many threads can be used when you upload files through POST.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. 
+     * Return or set how many threads can be used when you upload files through POST.
      */
     MaxInternetTransferThreads: number;
     /**
@@ -832,14 +847,14 @@ export interface WebTwainIO extends WebTwainUtil {
             errorString: string) => void
     ): void | boolean;
     /**
-     * [Deprecation] Return an index from the selected indices array. Read SelectedImagesIndices instead.
-     * [Alternative] Read SelectedImagesIndices instead.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use `SelectedImagesIndices` instead.
+     * Return an index from the selected indices array. 
      * @param indexOfIndices Specify the index of the specified image.
      */
     SaveSelectedImagesToBase64Binary(indexOfIndices: number): number;
     /**
-     * [Deprecation] Saves the selected images in the buffer to a base64 string.
-     * [Alternative] Use ConvertToBase64 instead.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use `ConvertToBase64` instead.
+     * Saves the selected images in the buffer to a base64 string.
      * @param successCallback A callback function that is executed if the request succeeds.
      * @param failureCallback A callback function that is executed if the request fails.
      * @argument result The resulting array of strings.
@@ -921,7 +936,8 @@ export interface WebTwainIO extends WebTwainUtil {
         flag: number
     ): boolean;
     /**
-     * [Deprecation] Set a cookie string into the Http Header to be used when uploading scanned images through POST.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions.
+     * Set a cookie string into the Http Header to be used when uploading scanned images through POST.
      * @param cookie The cookie.
      */
     SetCookie(cookie: string): boolean;
@@ -932,6 +948,24 @@ export interface WebTwainIO extends WebTwainUtil {
      * @param type The format of the file.
      */
 	ShareImages(fileName: string, indices: number[], type: DynamsoftEnumsDWT.EnumDWT_ImageType):Promise<void>;
+	/**
+     * Copy selected area to Blob or base64.
+     * @param index Image to be copied from.
+	 * @param area Area of image to be copied. X,Y is top left corner origin, width and height is size of area to be copied.
+     * @param type The target image type of the blob/base64.
+	 * @param imageFormatType Specify if the return should be Blob or base64 string. Only support blob or base64
+     */
+	OutputSelectedAreaAsync(
+        index: number, 
+        area: {
+            x: number, 
+            y: number,  
+            width: number,
+            height: number
+        },
+        type: DynamsoftEnumsDWT.EnumDWT_ImageType | number, 
+        imageFormatType: DynamsoftEnumsDWT.EnumDWT_ImageFormatType | number, 
+	): Promise < Blob|string > ;
 }
 export interface Base64Result {
     /**

package/dist/types/WebTwain.Util.d.ts

@@ -22,6 +22,7 @@ export interface WebTwainUtil {
      */
     readonly ProductFamily: string;
     /**
+	 * @deprecated since version 18.0. This property will be removed in future versions. Use `Dynamsoft.DWT.ProductKey` instead.
      * Return or set the ProductKey.
      */
     ProductKey: string;
@@ -76,6 +77,7 @@ export interface WebTwainUtil {
      */
     readonly VersionInfo: string;
     /**
+	 * @deprecated since version 18.0. This function will be removed in future versions. Use property `Dynamsoft.DWT.ProductKey` instead.
      * Update / set the ProductKey.
      * @param productKey the ProductKey.
      */

package/dist/types/WebTwain.Viewer.d.ts

@@ -3,6 +3,7 @@ import { DynamsoftEnumsDWT } from "./Dynamsoft.Enum";
 
 export interface WebTwainViewer extends WebTwainAcquire {
     /**
+	 * @deprecated since version 16.2. This function will be removed in future versions. Use `Viewer.bind` and `Viewer.show` instead.
      * Create a Dynamsoft Viewer instance and bind it to the WebTwain instance.
      * @param elementId Specify an HTML element to create the viewer.
      */
@@ -10,58 +11,72 @@ export interface WebTwainViewer extends WebTwainAcquire {
         elementId: string
     ): boolean;
     /**
+	 * @deprecated since version 16.2. This function will be removed in future versions. Use `Viewer.unbind` instead.
      * Unbind and destroy the viewer.
      */
     UnbindViewer(): boolean;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.background` instead.
      * Return or set the background colour of the viewer.
      */
     BackgroundColor: number;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.selectedPageBorder` instead.
      * Return or set the border colour for selected image(s).
      */
     SelectionImageBorderColor: number;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.fitWindow` instead.
      * Return or set how the image is fit in the viewer.
      */
     FitWindowType: number;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.fitWindow` instead.
      * Return or set the border colour for selected image(s).
      */
     IfFitWindow: boolean;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.height` instead.
      * Return or set the height of the viewer.
      */
     Height: number | string;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.width` instead.
      * Return or set the width of the viewer.
      */
     Width: number | string;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `ViewerEvent.imageX` instead.
      * Return the horizontal coordinate of the mouse.
      */
     readonly MouseX: number;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `ViewerEvent.imageY` instead.
      * Return the vertical coordinate of the mouse.
      */
     readonly MouseY: number;
     /**
+	 * @deprecated since version 16.2. This function will be removed in future versions. Use `Viewer.cursor` instead.
      * Return or set the shape of the cursor.
      */
     MouseShape: boolean;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.ifAutoScroll` instead.
      * Return or set whether the thumbnails view scrolls when new images come in.
      */
     IfAutoScroll: boolean;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.updatePageNumberStyle` instead.
      * Return or set whether to show the page numbers.
      */
     ShowPageNumber: boolean;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.pageMargin` instead.
      * Return or set the margin between images (in pixels).
      */
     ImageMargin: number;
     /**
+	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.zoom` instead.
      * Return or set the zoom factor.
      */
     Zoom: number;
@@ -131,6 +146,7 @@ export interface DynamsoftViewer {
      */
     pageMargin: number | string;
     /**
+	 * @deprecated since version 18.4. This property will be removed in future versions. Use function `updateSelectionBoxStyle` instead.
      * [Scope] Main viewer
      * [Description] Set the border color of the selected area.
      * [Usage Notes] 'Invalid property value' is reported when the set value does not meet the CSS standard.
@@ -181,12 +197,14 @@ export interface DynamsoftViewer {
      */
     selectedPageBackground: string;
     /**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use function `updatePageNumberStyle` instead.
      * [Scope] Main viewer
      * [Description] Whether to show the page number. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
      */
     showPageNumber: boolean;
 	 /**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use function `updateCheckboxStyle` instead.
      * [Scope] Main viewer
      * [Description] Whether to show the checkbox for multiple selected. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
@@ -286,31 +304,37 @@ export interface DynamsoftViewer {
      * [Scope] Main viewer
      * [Description] Clear the selected area(s) on the current image.
      */
-    clearSelectedAreas(): void;
+    clearSelectedAreas(): boolean;
     /**
      * [Scope] Main viewer
      * [Description] Set one or more rectangular area(s) on the specified image.
      * @param areas Specify the areas.
      */
-    setSelectedAreas(areas: Area[]): void;
+    setSelectedAreas(areas: Area[]): boolean;
     /**
      * [Scope] Main viewer
      * [Description] Fit the image to the window
      * @param type Specify a type to fit. (width, height, both)
      */
-    fitWindow(type?: 'height' | 'width'): void;
+    fitWindow(type?: 'height' | 'width'): boolean;
 	/**
      * [Scope] Main viewer
      * Update checkbox style
      * @argument checkboxSettings Settings for checkboxex.
      */
-	updateCheckboxStyle(checkboxSettings?: CheckboxSettings): void;
+	updateCheckboxStyle(checkboxSettings?: CheckboxSettings): boolean;
 	/**
      * [Scope] Main viewer
 	 * Update page number style
 	 * @argument pageNumberSettings Settings for page numbers.
      */
-	updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): void;
+	updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): boolean;
+	/**
+     * [Scope] Main viewer
+     * Sets the graphical style for the selection box in the Viewer.
+     * @argument selectionBoxStyleSettings Settings for selection box.
+     */
+	updateSelectionBoxStyle(selectionBoxStyleSettings?: SelectionBoxStyleSettings): boolean;
     /**
      * [Description] Set the CSS class name of the specified button defined in updateUISetting.
      * @param name Specify the button.
@@ -513,12 +537,14 @@ export interface ThumbnailViewerSettings {
      */
 	allowResizing?: boolean;
     /**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use `pageNumber` instead.
      * [Scope] Thumbnail viewer
      * [Description] Whether to show the page number. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
      */
     showPageNumber?: boolean;
 	/**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use `checkbox` instead.
      * [Scope] Thumbnail viewer
      * [Description] Whether to show the checkbox for multiple selected. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
@@ -627,7 +653,13 @@ export interface ImageEditor {
 	zoomOrigin?: {
 		x: string; //Default is "center", values: "left", "right", "center".
 		y: string; //Default is "center", values: "top", "bottom", "center"
-	};
+	};	
+	/**
+     * [Scope] ImageEditor viewer
+     * Set the selction box styling.
+     * @argument selectionBoxStyleSettings Settings for selection box.
+     */
+	updateSelectionBoxStyle(selectionBoxStyleSettings?: SelectionBoxStyleSettings): boolean;
 }
 export interface ThumbnailViewer {
     /**
@@ -734,12 +766,14 @@ export interface ThumbnailViewer {
      */
 	allowResizing: boolean;
     /**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use function `updatePageNumberStyle` instead.
      * [Scope] Thumbnail viewer
      * [Description] Whether to show the page number. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
      */
     showPageNumber: boolean;
 	/**
+	 * @deprecated since version 17.3. This property will be removed in future versions. Use function `updateCheckboxStyle` instead.
      * [Scope] Thumbnail viewer
      * [Description] Whether to show the checkbox for multiple selected. The default value is false.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
@@ -904,3 +938,11 @@ export interface PageNumberSettings {
   translateX?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to itself
   translateY?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to itself
 }
+export interface SelectionBoxStyleSettings {
+  borderColor?: string;  //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
+  borderWidth?: number;  //Default: 1. Pixels. Width of individual pattern segments.
+  lineDash?: [number,number];  //Default: [5,2]. Pixels. Line spacing where x is shaded pixels and y is gap in pixels.
+  handleWidth?: number;  //Default: 9. Pixels.
+  handleHeight?: number;   //Default: 9. Pixels
+  handleColor?: string;  //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
+}

package/dist/types/WebTwain.d.ts

@@ -12,19 +12,23 @@ export interface WebTwain extends WebTwainViewer {
      */
     Addon: Addon;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     AllowMultiSelect: boolean;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     AllowPluginAuthentication: boolean;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     AsyncMode: boolean;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     BorderStyle: DynamsoftEnumsDWT.EnumDWT_BorderStyle | number;
     /**
@@ -32,11 +36,13 @@ export interface WebTwain extends WebTwainViewer {
      */
     readonly bReady: boolean;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     BrokerProcessType: number;
     /**
-     * [Deprecation] This API is no longer needed.
+	 * @deprecated since version 10.1. This property will be removed in future versions. 
+     * This API is no longer needed.
      */
     EnableInteractiveZoom: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dwt",
-    "version": "18.3.0",
+    "version": "18.4.0",
     "author": {
         "name": "Dynamsoft",
         "url": "https://www.dynamsoft.com"