Skip to content

Jackson branch #597

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
Apr 11, 2023
Merged

Jackson branch #597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a3734a
Merge pull request #596 from dynamsoft-docs/preview
lunaaaw Apr 10, 2023
c1134de
Update WebTwain_Viewer.md
ztyyLV Apr 11, 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
169 changes: 4 additions & 165 deletions info/api/WebTwain_Viewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,16 +426,7 @@ Generate a independent ThumbnailViewer object.

**Syntax**

<div class="sample-code-prefix template2"></div>

>- 17.3+
>- 17.2.5
>
```typescript
/**
*
* @param thumbnailViewerSettings Configure the ThumbnailViewer object
*/
createThumbnailViewer(
thumbnailViewerSettings?: ThumbnailViewerSettings
): ThumbnailViewer;
Expand Down Expand Up @@ -635,165 +626,13 @@ interface ViewMode {
scrollDirection?: string;
}
```
```typescript
/**
 * 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;
}
```

**Parameters**

`thumbnailViewerSettings`: Configure the ThumbnailViewer object

**Availability**

<div class="availability">
<table>

Expand Down