{WebTwainObject}.Viewer

{WebTwainObject} denotes the WebTwain instance.

Methods

Properties

Events

bind

Create a Dynamsoft Viewer instance and bind it to the WebTwain instance.

Syntax

bind(element: HTMLDivElement | HTMLElement) : boolean;

Parameters

element: Specify an HTML element to create the viewer.

Example

var DWObject, template;
Dynamsoft.DWT.CreateDWTObjectEx(
    {
        WebTwainId: "a",
    },
    function (obj) {
        DWObject = obj;
        template = DWObject.Viewer.getElementById("dwtcontrolContainer_temp3");
        DWObject.Viewer.width=500;
        DWObject.Viewer.height=600;
        DWObject.Viewer.show();    
    }, 
    function (errorCode, errorString) {
        console.log(errorString);
    });

Availability

Usage notes

Replace the previous BindViewer method.

clearSelectedAreas

Clear the selected area(s) on the current page.

Syntax

clearSelectedAreas(): void;

Availability

Example

DWObject.Viewer.clearSelectedAreas();

createCustomElement

Add a custom page DIV element and specify its position and display order. Generate an independent CustomElement object.

Syntax

createCustomElement(
    element: HTMLDivElement,
    location?: string,
    ifFull?: boolean
): CustomElement;

interface CustomElement {
    /**
     * Show the custom element.
     */
    show(): boolean;
    /**
     * Hide the custom element.
     */
    hide(): boolean;
    /**
     * Remove the custom element.
     */
    dispose(): boolean;
    /**
     * Return the created element.
     */
    element?: any;
};

Parameters

element: Specify the HTMLDivElement.

location: Define where to place the custom element. The allowed values are “left” and “right”, and the default value is “right”.

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.

Availability

Example

var myElement = document.createElement("div");
myElement.style = "width:100px;height:200px;background:red";
var customElement = DWObject.Viewer.createCustomElement(
  myElement,
  "right",
  false
);
customElement.show();

Usage notes

Only one CustomElement object can be created. If you try creating another one, you’ll get the error ‘A CustomElement already exists.’, and the existing CustomElement object will be returned.

If the width defined by the CustomElement object exceeds the width of the main viewer, the width of the main viewer is used.

The method unbind() will dispose all created CustomElement objects, ThumbnailViewer objects and ImageEditor objects.

createImageEditor

Generate an independent ImageEditor object.

Syntax

createImageEditor(
    editorSettings?: EditorSettings
): ImageEditor;

interface ImageEditor {
    /**
     * Show the ImageEditor object.
     */
    show(): boolean;
    /**
     * Hide the ImageEditor object.
     */
    hide(): boolean;
    /**
     * Remove the ImageEditor object.
     */
    dispose(): boolean;
};

Parameters

editorSettings: Configure the object.

Availability

Example

The example code shows 2 ways to use the API createImageEditor()

// Use default settings
var imageEditor = DWObject.Viewer.createImageEditor();
imageEditor.show();

// Customize the editor
var editorSettings = {
  /* Show the editor within the DIV 'imageEditor'*/
  element?: document.getElementById("imageEditor"),
  width?: 600,
  height?: 400,
  border?: "1px solid rgb(204, 204, 204)",
  topMenuBorder?: "",
  innerBorder?: "",
  background?: "rgb(255, 255, 255)",
  promptToSaveChange?: true,
  buttons?: {
    titles?: {
      previous?: "Previous Image",
      next?: "Next Image",
      print?: "Print Image",
      scan?: "Scan Documents",
      load?: "Load Local Images",
      rotateleft?: "Rotate Left",
      rotate?: "Rotate",
      rotateright?: "Rotate Right",
      deskew?: "Deskew",
      crop?: "Crop Selected Area",
      cut?: "Cut Selected Area",
      changeimagesize?: "Change Image Size",
      flip?: "Flip Image",
      mirror?: "Mirror Image",
      zoomin?: "Zoom In",
      originalsize?: "Show Original Size",
      zoomout?: "Zoom Out",
      stretch?: "Stretch Mode",
      fit?: "Fit Window",
      fitw?: "Fit Horizontally",
      fith?: "Fit Vertically",
      hand?: "Hand Mode",
      rectselect?: "Select Mode",
      zoom?: "Click to Zoom In",
      restore?: "Restore Original Image",
      save?: "Save Changes",
      close?: "Close the Editor",
      removeall?: "Remove All Images",
      removeselected?: "Remove All Selected Images",
    },
    visibility?: {
      scan?: true,
      load?: true,
      print?: true,
      removeall?: true,
      removeselected?: true,
      rotateleft?: true,
      rotate?: true,
      rotateright?: true,
      deskew?: true,
      crop?: true,
      cut?: true,
      changeimagesize?: true,
      flip?: true,
      mirror?: true,
      zoomin?: true,
      originalsize?: true,
      zoomout?: true,
      stretch?: true,
      fit?: true,
      fitw?: true,
      fith?: true,
      hand?: true,
      rectselect?: true,
      zoom?: true,
      restore?: true,
      save?: true,
      close?: true,
    },
  },
  dialogText?: {
    dlgRotateAnyAngle?: [
      "Angle :",
      "Interpolation:",
      "Keep size",
      "  OK  ",
      "Cancel",
    ],
    dlgChangeImageSize?: [
      "New Height :",
      "New Width :",
      "Interpolation method:",
      "  OK  ",
      "Cancel",
    ],
    saveChangedImage?: [
      "You have changed the image, do you want to keep the change(s)?",
      "  Yes  ",
      "  No  ",
    ],
    selectSource?: [
      "Select Source:",
      "Select",
      "Cancel",
      "There is no source available",
    ],
  },
};

var imageEditor = DWObject.Viewer.createImageEditor(editorSettings);
imageEditor.show();

Usage notes

Replace the previous ShowImageEditor() method.

Only one ImageEditor object can be created. If you try creating it again, you’ll get the error ‘An ImageEditor already exists.’ and the existing ImageEditor object will be returned.

The method unbind() will dispose all created CustomElement objects, ThumbnailViewer objects and ImageEditor objects.

createThumbnailViewer

Generate a independent ThumbnailViewer object.

Syntax

• 17.3+
• 17.2.5

/**
 * 
 * @param thumbnailViewerSettings Configure the ThumbnailViewer object
 */
createThumbnailViewer(
    thumbnailViewerSettings?: ThumbnailViewerSettings
): ThumbnailViewer;
interface ThumbnailViewer {
    /**
     * Show the ThumbnailViewer object.
     */
    show(): boolean;
    /**
     * Hide the ThumbnailViewer object.
     */
    hide(): boolean;
    /**
     * Remove the ThumbnailViewer object.
     */
    dispose(): boolean;
    /**
     * Change the view mode of the thumbnail viewer.
     * @param viewMode Specify the new mode.
     */
    updateViewMode(viewMode: ViewMode): void;
    /**
     * Change the checkbox style. Available in v17.3+.
     * @param checkboxSettings Specify the checkbox settings.
     */
    updateCheckboxStyle(checkboxSettings?: CheckboxSettings): void;
    /**
     * Change the page number style. Available in v17.3+.
     * @param pageNumberSettings Specify the page number settings.
     */
    updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): void;
    /**
     * Bind a listner to the specified event. You can bind one or multiple listeners to the same event.
     * @param eventName Specify the event name.
     * @param callback Specify the listner.
     */
    on(eventName: string, callback: (event: ThumbnailViewerEvent | KeyboardEvent, domEvent?: MouseEvent) => void): void;
    /**
     * Unbind event listener(s) from the specified viewer event.
     * @param eventName Specify the event.
     * @param callback Specify the listener to remove
     */
    off(eventName: string, callback?: () => void): void;
}
interface ThumbnailViewerSettings {
    /**
     * Specify how many images to display per row.
     */  
    columns?: number;
    /**
     * Specify how many images to display per column.
     */  
    rows?: number;    
    /**
     * Whether to allow keyboard control. Default: true.
     */  
    allowKeyboardControl?: boolean;
    /**
     * Whether to allow page dragging to reorder the pages.
     * Default: true.
     */
    allowPageDragging?: boolean;
    /**
     * Whether to allow resizing of the thumbnail viewer.
     * Default: false.
     */
    allowResizing?: boolean;
    /**
     * Set or return the CSS rule for the background of the thumbnail viewer.
     * Default: "rgb(255, 255, 255)".
     */
    background?: string;
    /**
     * Set or return the CSS rule for the border of the thumbnail viewer.
     * Default: "".
     */
    border?: string;
    /**
     * Set or return the CSS rule for the background of the page the mouse hovers over in the thumbnail viewer.
     * Default: "rgb(239, 246, 253)".
     */
    hoverPageBackground?: string;
    /**
     * Set or return the CSS rule for the border of the page the mouse hovers over in the thumbnail viewer.
     * Default: "1px solid rgb(238, 238, 238)".
     */
    hoverPageBorder?: string;
    /**
     * Set or return the location of the thumbnail viewer. Allowed values are "left", "right", "top", "bottom".
     * Default: "left".
     */
    location?: string;
    /**
     * Set or return the CSS rule for the background of a normal page in the thumbnail viewer.
     * Default: "transparent".
     */
    pageBackground?: string;
    /**
     * Set or return the CSS rule for the border of a normal page in the thumbnail viewer.
     * Default: "1px solid rgb(238, 238, 238)".
     */
    pageBorder?: string;
    /**
     * Set or return the margin between two adjacent images and the margin between an image and the border of the thumbnail viewer. The value can either be in pixels or percentage.
     * Default: 10.
     */
    pageMargin?: number | string;
    /**
     * Set or return the CSS rule for the background of the placeholder which appears when you drag page(s) to reorder them in the thumbnail viewer.
     * Default: "rgb(251, 236, 136)".
     */
    placeholderBackground?: string;
    /**
     * Set or return whether the pages are arranged vertically or horizontally.
     * Default: "vertical". Allowed values are "vertical" and "horizontal".
     */
    scrollDirection?: string;
    /**
     * Set or return the CSS rule for the background of the selected page(s) in the thumbnail viewer.
     * Default: "rgb(199, 222, 252)".
     */
    selectedPageBackground?: string;
    /**
     * Set or return the CSS rule for the border of the selected page(s) in the thumbnail viewer.
     * Default: "1px solid rgb(125,162,206)".
     */
    selectedPageBorder?: string;
    /**
     * Set or return the size of the thumbnail viewer. The value can either be in pixels or percentage (based on the width or height of the entire viewer).
     * Default: "30%".
     */
    size?: number | string;
    /**
     * Set whether to select the index in the upper left corner of the viewer when scrolling.
     * Default: false.
     */
    autoChangeIndex?: boolean;
    checkbox?: {
      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"
      borderWidth?: number | string;  //default: "2px", unit: px, percentage value not supported
      borderColor?: string; //default: "#000000"
      checkMarkColor?: string; //default: "#000000"
      checkMarkLineWidth?: number | string; //default: "2px", unit: px, percentage value not supported
      borderRadius?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%",relative to itself
      opacity?: number; //default:0.5, value range [0-1], value greater 1 defaults to 1
      left?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
      top?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
      right?: number | string;  //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
      bottom?: number | string;  //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
      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
    };
    pageNumber?: {
      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"            
      borderWidth?: number | string; //default: "1px", unit: px, percentage value not supported
      borderColor?: string; //default: "#a79898"
      borderRadius?: number | string; //default: "50%", number unit: px, string value: "10px"/"10%", relative to itself
      opacity?:number; //default: 0.5, value range [0-1], value greater 1 defaults to 1
      color?: string; //default: "#000000", supports #16 hexadecimal only
      fontFamily?: string; //default: "sans-serif"
      fontSize?: number | string; //default: 12, unit: px, percentage value not supported
      left?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
      top?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
      right?: number | string; //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
      bottom?: number | string; //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
      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
    }
};
interface ThumbnailViewerEvent {
    // The index of the current page.
    index: number;
    // The x-coordinate of the browser page.
    pageX: number;
    // The y-coordinate of the browser page.
    pageY: number;
};
interface ViewMode {
    /**
     * Specify the number of images per row.
     */
    columns?: number;
    /**
     * Specify the number of images per column.
     */
    rows?: number;
    /**
     * Set or return whether the pages are arranged vertically or horizontally.
     * Default: "vertical". Allowed values are "vertical" and "horizontal".
     */
    scrollDirection?: string;
}

/** 
 * Generate a independent ThumbnailViewer object. 
 * @param thumbnailViewerSettings Configure the ThumbnailViewer object 
 */ 
createThumbnailViewer( 
    thumbnailViewerSettings?: thumbnailViewerSettings 
): ThumbnailViewer; 
interface ThumbnailViewer { 
    /** 
    * Show the ThumbnailViewer object. 
    */ 
    show(): boolean; 
    /** 
    * Hide the ThumbnailViewer object. 
    */ 
    hide(): boolean; 
    /** 
    * Remove the ThumbnailViewer object. 
    */ 
    dispose(): boolean; 
    /** 
    * Change the view mode of the thumbnail viewer. 
    * @param viewMode Specify the new mode. 
    */ 
    updateViewMode(viewMode: ViewMode): void; 
    /** 
    * Bind a listner to the specified event. You can bind one or multiple listeners to the same event. 
    * @param eventName Specify the event name. 
    * @param callback Specify the listner. 
    */ 
    on(eventName: string, callback: (event: ThumbnailViewerEvent | KeyboardEvent, domEvent?: MouseEvent) => void): void; 
    /** 
    * Unbind event listener(s) from the specified viewer event. 
    * @param eventName Specify the event. 
    * @param callback Specify the listener to remove 
    */ 
    off(eventName: string, callback?: () => void): void; 
    /** 
    * Whether to allow keyboard control. Default: true. 
    */ 
    allowKeyboardControl: boolean; 
    /** 
    * Whether to allow page dragging to reorder the pages. 
    * Default: true. 
    */ 
    allowPageDragging: boolean; 
    /** 
    * Whether to allow resizing of the thumbnail viewer. 
    * Default: false. 
    */ 
    allowResizing: boolean; 
    /** 
    * Set or return the CSS rule for the background of the thumbnail viewer. 
    * Default: "rgb(255, 255, 255)". 
    */ 
    background: string; 
    /** 
    * Set or return the CSS rule for the border of the thumbnail viewer. 
    * Default: "". 
    */ 
    border: string; 
    /** 
    * Set or return the CSS rule for the background of the page the mouse hovers over in the thumbnail viewer. 
    * Default: "rgb(239, 246, 253)". 
    */ 
    hoverPageBackground: string; 
    /** 
    * Set or return the CSS rule for the border of the page the mouse hovers over in the thumbnail viewer. 
    * Default: "1px solid rgb(238, 238, 238)". 
    */ 
    hoverPageBorder: string; 
    /** 
    * Set or return the location of the thumbnail viewer. Allowed values are "left", "right", "top", "bottom". 
    * Default: "left". 
    */ 
    location: string; 
    /** 
    * Set or return the CSS rule for the background of a normal page in the thumbnail viewer. 
    * Default: "transparent". 
    */ 
    pageBackground: string; 
    /** 
    * Set or return the CSS rule for the border of a normal page in the thumbnail viewer. 
    * Default: "1px solid rgb(238, 238, 238)". 
    */ 
    pageBorder: string; 
    /** 
    * Set or return the margin between two adjacent images and the margin between an image and the border of the thumbnail viewer. The value can either be in pixels or percentage. 
    * Default: 10. 
    */ 
    pageMargin: number | string; 
    /** 
    * Set or return the CSS rule for the background of the placeholder which appears when you drag page(s) to reorder them in the thumbnail viewer. 
    * Default: "rgb(251, 236, 136)". 
    */ 
    placeholderBackground: string; 
    /** 
    * Set or return whether the pages are arranged vertically or horizontally. 
    * Default: "vertical". Allowed values are "vertical" and "horizontal". 
    */ 
    scrollDirection: string; 
    /** 
    * Set or return the CSS rule for the background of the selected page(s) in the thumbnail viewer. 
    * Default: "rgb(199, 222, 252)". 
    */ 
    selectedPageBackground: string; 
    /** 
    * Set or return the CSS rule for the border of the selected page(s) in the thumbnail viewer. 
    * Default: "1px solid rgb(125,162,206)". 
    */ 
    selectedPageBorder: string; 
    /** 
    * Set or return whether page numbers are shown. 
    * Default: false. 
    */ 
    showPageNumber: boolean; 
    /** 
    * Set or return the size of the thumbnail viewer. The value can either be in pixels or percentage (based on the width or height of the entire viewer). 
    * Default: "30%". 
    */ 
    size: number | string; 
    /** 
    * Set whether to select the index in the upper left corner of the viewer when scrolling. 
    * Default: false. 
    */ 
    autoChangeIndex: boolean; 
    /** 
    * Show checkbox on image(s). 
    */ 
    showCheckbox: boolean; 
}; 
interface ThumbnailViewerEvent { 
    // The index of the current page. 
    index: number; 
    // The x-coordinate of the browser page. 
    pageX: number; 
    // The y-coordinate of the browser page. 
    pageY: number; 
}; 
interface ViewMode { 
    /** 
    * Specify the number of images per row. 
    */ 
    columns: number; 
    /** 
    * Specify the number of images per column. 
    */ 
    rows: number; 
    /** 
    * Set or return whether the pages are arranged vertically or horizontally. 
    * Default: "vertical". Allowed values are "vertical" and "horizontal". 
    */ 
    scrollDirection: string; 
}

Availability

Example

The example code shows 2 ways to use the API createThumbnailViewer()

// Use default settings
var objThumbnailViewer = DWObject.Viewer.createThumbnailViewer();
objThumbnailViewer.background = "rgb(0,0,255)";
objThumbnailViewer.show();

// Customize the thumbnail viewer
var thumbnailViewerSettings = {
    location: 'left',
    size: '30%',
    columns: 1,
    rows: 3,
    scrollDirection: 'vertical', // 'horizontal'
    pageMargin: 10,
    background: "rgb(255, 255, 255)",
    border: '',
    allowKeyboardControl: true,
    allowPageDragging: true,
    allowResizing: false,
    pageBackground: "transparent",
    pageBorder: "1px solid rgb(238, 238, 238)",
    hoverBackground: "rgb(239, 246, 253)",
    hoverPageBorder: "1px solid rgb(238, 238, 238)",
    placeholderBackground: "rgb(251, 236, 136)",
    selectedPageBorder: "1px solid rgb(125,162,206)",
    selectedPageBackground: "rgb(199, 222, 252)"
}​​​​​​​;

var thumbnail = DWObject.Viewer.createThumbnailViewer(thumbnailViewerSettings);
thumbnail.show();

Usage notes

For the CheckboxSettings and PageNumberSettings interface, please refer to the APIs updateCheckboxStyle and updatePageNumberStyle.

The following table shows the events available to a ThumbnailViewer object.

By default, scrolling the scroll bar on Thumbnail does not trigger the topchanged event.

Only one ThumbnailViewer object can be created. If you try creating it again, you will get the error ‘A ThumbnailViewer already exists.’ and the existing ThumbnailViewer object will be returned.

The method unbind() will dispose all created CustomElement objects, ThumbnailViewer objects and ImageEditor objects.

first

Show the first page and return the index which should be 0. If there is no page in the viewer, -1 is returned.

Syntax

first():number;

Availability

Example

DWObject.Viewer.first();

fitWindow

Set how the page is fit in the viewer.

Syntax

fitWindow(
    type?: string
): void

Parameters

type: Specify how to fit. Allowed values are “width” and “height”

Availability

Example

DWObject.Viewer.fitWindow();

Usage notes

This API only works if the view mode of the viewer is set to -1 by -1 ( singlePageMode is true).

The allowed values are

width: Fit the page vertically. height: Fit the page horizontally.

If no parameter is provided, it tries to fit the whole page within the viewer.

gotoPage

Show the specified page and return its index.

Syntax

gotoPage(
    index: number
): number;

Parameters

index: Specify the page.

Availability

Example

DWObject.Viewer.gotoPage(0);

hide

Hide the viewer.

Syntax

hide(): boolean;

Availability

Example

DWObject.Viewer.hide();

last

Show the last page and return its index. If there is no page in the viewer, -1 is returned.

Syntax

last():number;

Availability

Example

DWObject.Viewer.last();

next

Show the next page and return its index. If there is no page in the viewer, -1 is returned.

Syntax

next(): number;

Availability

Example

DWObject.SelectImages([3]); //Select the 4th page.
var currentIndex = DWObject.Viewer.next(); // return 4 which represents the 5th page.

off

Unbind event listener(s) from the specified viewer event.

Syntax

Viewer.off(
    eventName: string,
    callback?: () => void
): void;

Parameters

eventName: Specify the event.

callback: Specify the listener to remove

Availability

Example

DWObject.Viewer.off("pageAreaSelected");

Usage notes

If no listener is specified, all listeners will be removed.

on

Bind a listner to the specified event. You can bind one or multiple listeners to the same event.

Syntax

Viewer.on(
    eventName: string,
    callback: (event: ViewerEvent) => void
): void;

Parameters

eventName: Specify the event name. callback: Specify the listner.

Availability

Example

//bind pageAreaSelected event on the main viewer
var callback = function (sImageIndex, rect) {
  console.log(sImageIndex);
};
DWObject.Viewer.on("pageAreaSelected", callback);

//bind click event on the thumbnail viewer
var objThumbnailViewer = DWObject.Viewer.createThumbnailViewer();
objThumbnailViewer.show();
objThumbnailViewer.on("click", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

previous

Show the previous page and return its index. If there is no page in the viewer, -1 is returned.

Syntax

previous(): number;

Availability

Example

DWObject.SelectImages([3]); //Select the 4th page.
var currentIndex = DWObject.Viewer.previous(); // return 2 which represents the 3rd page.

render

Refresh the viewer.

Syntax

render(): boolean;

Availability

Example

DWObject.Viewer.on("pageRendered", function (index) {
  console.log(index);
});

DWObject.Viewer.render(); //It will trigger the pageRendered event

setButtonClass

Set the CSS class name of the specified button.

Syntax

setButtonClass(
    name: string,
    className: string
): boolean;

Parameters

name: Specify the button.

className: Specify the CSS class name.

Usage notes

Use this method to fine-tune the buttons in the viewer with CSS.

Example

DWObject.Viewer.setButtonClass("crop", "CropClass");

setSelectedAreas

Set one or more rectangular area(s) on the current page.

Syntax

setSelectedAreas(
    areas: Area[]
): void;

interface Area {
    left: number,
    top: number,
    right: number,
    bottom: number,
};

Parameters

areas: Specify the rectangular area(s).

Availability

Usage notes

The coordinates are based on the size of the original page (instead of the size of the viewer).

This method only works when cursor is set to “crosshair”.

Example

DWObject.Viewer.setSelectedAreas([
  {
    left: 0,
    top: 0,
    right: 100,
    bottom: 100,
  },
  {
    left: 200,
    top: 200,
    right: 400,
    bottom: 500,
  },
]);

setViewMode

Set the view mode of the viewer.

Syntax

setViewMode(
    columns: number,
    rows: number
): boolean;

Parameters

columns: Specify the number of images per column.

rows: Specify the number of images per row.

Availability

Usage notes

Setting the view mode as -1 by -1 is equivalent to setting singlePageMode to true.

Example

DWObject.Viewer.setViewMode(2, 2);

show

Show the viewer.

Syntax

show(): boolean;

Availability

Example

DWObject.Viewer.show();

unbind

Unbind and destroy the viewer.

Syntax

unbind(): boolean;

Availability

Usage notes

Replace the previous UnbindViewer method.

Example

DWObject.Viewer.unbind();

acceptDrop

Set whether to load files dropped over the viewer area. The default value is true.

Syntax

acceptDrop: boolean;

Availability

Example

DWObject.Viewer.acceptDrop = true;

allowSlide

Set whether to allow image navigation by swiping left or right on the viewer. The default value is true.

allowSlide: boolean;

Availability

Usage notes

This API only works if the view mode of the viewer is set to -1 by -1.

Example

DWObject.Viewer.allowSlide = true;

allowPageDragging

Set whether to allow page dragging to reorder the pages in the viewer. The default value is true.

allowPageDragging: boolean;

Availability

Example

DWObject.Viewer.setViewMode(2,2);
DWObject.Viewer.cursor = "pointer";
DWObject.Viewer.allowPageDragging = false; //Disable drag&drop.

background

Return or set the background of the viewer.

Syntax

background: string;

Availability

Usage notes

Replace the previous BackgroundColor method. Now you can specify the backgournd by CSS which may be a single color or even an image. Read more on the background shorthand CSS.

Example

DWObject.Viewer.background = "rgb(255, 255, 255)";

border

Return or set the border of the viewer.

Syntax

border: string;

Availability

Usage notes

The default value is “1px solid rgb(204, 204, 204)”. Now you can specify the border by CSS. Read more on the border shorthand CSS.

Example

DWObject.Viewer.border = "2px solid rgb(204, 204, 204)";

cursor

Return or set the shape of the cursor.

Syntax

cursor: string;

Availability

Usage Notes

The allowed values are:

Value	Description
default	The shape is .
crosshair	The shape is (default setting), you can select one or multiple area(s) on the page.
pointer	The shape is . If the displayed page is bigger than the viewer, the page can be moved.
zoom-in	The shape is , supports click the page to zoom in. Only works if the view mode of the viewer is set to -1 by -1.

If there are selected areas on the page, changing the cursor property will clear them.

Example

DWObject.Viewer.cursor = "crosshair";

height

Return or set the height of the viewer.

Syntax

height: number | string;

Availability

Usage Notes

If a number is assigned, it means that number of pixels (px). If a string is assigned, it is either a fixed size like “500px” or a dynamic size like “50%” which follows standard CSS rules.

When reading the property, the value is always in pixels no matter what value was set to it.

Example

DWObject.Viewer.height = 350;
DWObject.Viewer.height = "350px";
DWObject.Viewer.height = "100%";

idPostfix

Return the postfix of the Ids of the elements in the viewer.

Syntax

readonly idPostfix: string;

Availability

Example

var myViewerIdPostfix = DWObject.Viewer.idPostfix;

ifAutoScroll

Return or set whether to scroll the viewer automatically when new pages are imported. Default: true;

Syntax

ifAutoScroll: string;

Availability

Example

DWObject.Viewer.ifAutoScroll = false;

innerBorder

Return or set the inner border of the viewer.

Syntax

innerBorder: string;

Availability

Example

DWObject.Viewer.innerBorder = "1px solid rgb(204, 204, 204)";

Usage notes

The default value is null. You can specify the border by CSS. Read more on the border shorthand CSS.

pageMargin

Return or set the margin between images.

Syntax

pageMargin: number | string;

Availability

Usage Notes

The page margin is only effective when the view mode is not -1 * -1 (in other words, singlePageMode is false ).

Example

DWObject.Viewer.pageMargin = 10;

selectedAreaBorderColor

Set the border color of the selected area. Also applies to the selection box on the video opened by the method showVideo.

Syntax

selectedAreaBorderColor: string;

Availability

Usage notes

The default value is “rgba(0, 0, 0, 1)”.

Example

DWObject.Viewer.selectedAreaBorderColor = "rgba(0, 0, 0, 1)";

selectedPageBackground

Set the selected page background color of the Thumbnail viewer.

Syntax

selectedPageBackground: string;

Availability

Usage notes

The default value is “rgb(199, 222, 252)”. You can specify the backgournd by CSS which may be a single color or even an image. Read more on the background shorthand CSS.

Example

DWObject.Viewer.selectedPageBackground = "rgb(255, 0, 0)";

selectedPageBorder

Return or set the border style for selected page(s).

Syntax

selectedPageBorder: string;

Availability

Usage Notes

This API is only effective when the view mode is not -1 * -1 (in other words, singlePageMode is false ).

The default value is “1px solid rgb(125, 162, 206)”. Now you can specify the border by CSS. Read more on the border shorthand CSS.

Example

DWObject.Viewer.selectedPageBorder = "3px solid rgb(125,162,206)";

selectionRectAspectRatio

Specify an aspect ratio to be used when selecting an rectangular area on a page.

Syntax

selectionRectAspectRatio: number | string;

Availability

Usage Notes

This API is only effective when drawing manually (it won’t work if the selection is done with the API setSelectedAreas()).

Example

DWObject.Viewer.selectionRectAspectRatio = 0.5;

singlePageMode

Set whether to use single page mode.

Syntax

singlePageMode: boolean;

Availability

Usage notes

The default value is false. If the thumbnail viewer is not shown, setting singlePageMode to true is equivalent to setting the view mode to -1 by -1. But if the thumbnail viewer is shown, singlePageMode will be changed to true automatically.

Example

// Use single page mode in the main viewer
DWObject.Viewer.singlePageMode = true;

// Use single page mode in the thumnail viewer
var objThumbnailViewer = DWObject.Viewer.createThumbnailViewer();
objThumbnailViewer.show();
DWObject.Viewer.singlePageMode = true;

width

Return or set the width of the viewer.

Syntax

width: number | string;

Availability

Usage Notes

If a number is assigned, it means that number of pixels (px). If a string is assigned, it is either a fixed size like “500px” or a dynamic size like “50%” which follows standard CSS rules.

When reading the property, the value is always in pixels no matter what value was set to it.

Example

DWObject.Viewer.width = 270;
DWObject.Viewer.width = "270px";
DWObject.Viewer.width = "100%";

zoom

Return or set the zoom factor, and then the current page will be enlarged or reduced.

Syntax

zoom: number;

Availability

Usage Notes

The zoom factor is only effective when the view mode is -1 * -1. Allowed values is from 0.02 to 65.

Example

DWObject.Viewer.zoom = 2.0;

autoChangeIndex

Set whether to make sure the first image in the viewer is always selected when scrolling through multiple images. The default value is false.

Syntax

autoChangeIndex: boolean;

Availability

Usage Notes

When set to true, the index in the upper left corner of the viewer will be selected when scrolling.

Example

DWObject.Viewer.autoChangeIndex = true;

updateCheckboxStyle

Update checkbox style

Syntax

updateCheckboxStyle(checkboxSettings?: CheckboxSettings): void;

interface CheckboxSettings {
  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"
  borderWidth?: number | string; //default: "2px", unit: px, percentage value not supported
  borderColor?: string; //default: "#000000"
  checkMarkColor?: string; //default: "#000000"
  checkMarkLineWidth?: number | string; //default: "2px", unit: px, percentage value not supported
  borderRadius?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%", relative to itself
  opacity?: number; //default:0.5, value range [0-1], value greater 1 defaults to 1
  left?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
  top?: number | string;  //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
  right?: number | string;  //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
  bottom?: number | string;  //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
  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
}

Parameters

checkboxSettings: Settings for checkboxex.

Availability

updatePageNumberStyle

Update page number style

Syntax

updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): void;

interface pageNumberSettings {       
  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"            
  borderWidth?: number | string; //default: "1px", unit: px, percentage value not supported
  borderColor?: string; //default: "#a79898"
  borderRadius?: number | string; //default: "50%", number unit: px, string value: "10px"/"10%", relative to itself
  opacity?:number; //default: 0.5, value range [0-1], value greater 1 defaults to 1
  color?: string; //default: "#000000", supports #16 hexadecimal only
  fontFamily?: string; //default: "sans-serif"
  fontSize?: number | string; //default: 12, unit: px, percentage value not supported
  left?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
  top?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to parent container
  right?: number | string; //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
  bottom?: number | string; //default: 0, number unit: px, string value: "10px"/"10%", relative to parent container
  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
}

Parameters

pageNumberSettings: Settings for page numbers.

Availability

selectionMode

Return or set the selection mode used.

Syntax

selectionMode: Dynamsoft.DWT.EnumDWT_SelectionMode | number;

Availability

Usage notes

The default value is 0 (Single). Even if checkbox is used, only one image can be selected if the selection mode is set to 0 (Single).

Example

DWObject.Viewer.setViewMode(2,2);
DWObject.Viewer.cursor = "pointer";
DWObject.Viewer.updateCheckboxStyle({
    visibility:"visible",
});
DWObject.Viewer.selectionMode = Dynamsoft.DWT.EnumDWT_SelectionMode.Multiple; // Multiple Selection

Events

On

Built-in callbacks that are triggered for a certain mouse event or keyboard event on a page.

Syntax

on(
    eventName: string,
    callback: (dwtEvent: ViewerEvent | KeyboardEvent, domEvent: MouseEvent) => void
): void;

interface ViewerEvent{
    // The index of the current page.
    index: number;
    //The x-coordinate of the upper-left corner of the page.
    imageX: number;
    //The y-coordinate of the upper-left corner of the page.
    imageY: number;
    // The x-coordinate of the browser page.
    pageX: number;
    // The y-coordinate of the browser page.
    pageY: number;
};

Parameters

eventName: Specify the event. Value: click, contextmenu, dblclick, mousemove, mousedown, mouseup, mouseout, mouseover, keydown, keyup.

callback: Specify the callback.

• dwtEvent: The viewer-specific event object.
• domEvent: The original mouse event object.

Availability

Usage notes

The events mouseout, mouseover, keydown and keyup are only triggered on desktop browsers. The events click, dbclick, mousemove, pageAreaSelected, and pageAreaUnselected are supported in ActiveX.

Example

DWObject.Viewer.on("click", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("dblclick", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("contextmenu", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("mousemove", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("mousedown", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("mouseup", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("mouseout", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("mouseover", function (dwtEvent, domEvent) {
  console.log(dwtEvent, domEvent);
});

DWObject.Viewer.on("keydown", function (keyboardEvent) {
  console.log(keyboardEvent);
});

DWObject.Viewer.on("keyup", function (keyboardEvent) {
  console.log(keyboardEvent);
});

pageAreaSelected

This event is triggered when user selects an area (draws a rectangle) or move a selected area on the current page.

Syntax

on('pageAreaSelected',
    (index: number, rect: rect)=> void
): void;

interface rect{
    // The index of the selected area. The index is 0-based. This is useful when you have multiple selected areas on one page.
    areaIndex: number;
    // The x-coordinate of the upper-left corner of the area.
    x: number;
    // The y-coordinate of the upper-left corner of the area.
    y: number;
    // The width of the selected area.
    width: number;
    // The height of the selected area.
    height: number;
};

Parameters

index: The index of the current page.

rect: Some attribute values of the selected area.

Availability

Example

DWObject.Viewer.on("pageAreaSelected", function (sImageIndex, rect) {
  console.log(sImageIndex);
});

DWObject.Viewer.off("pageAreaSelected");

pageAreaUnselected

This event is triggered when selected area(s) get cleared (when the user clicks outside of the drawn rectangle).

Syntax

on('pageAreaUnselected',
    (index: number) => void
): void;

Parameters

index: The index of the current page.

Availability

Example

DWObject.Viewer.on("pageAreaUnselected", function (sImageIndex) {
  console.log(
    "The selected areas on the page with index " +
      sImageIndex +
      " have been cleared"
  );
});

DWObject.Viewer.off("pageAreaUnselected");

pageRendered

This event is triggered when a page is rendered.

Syntax

on('pageRendered',
    (index: number) => void
): void;

Parameters

index: The index of the current page.

Availability

Example

DWObject.Viewer.on("pageRendered", function (index) {
  console.log(index);
});
DWObject.Viewer.render(); //It will trigger the pageRendered event

resize

This event is triggered when width & height of the viewer has been changed.

Syntax

on('resize',
    (width: number, height: number) => void
): void;

Parameters

width: The new width of the viewer.

height: The new height of the viewer.

Availability

Example

DWObject.Viewer.on("resize", function (width, height) {
  console.log(width, height);
});
DWObject.Viewer.width += 100;