Skip to content

Commit d7bd4eb

Browse files
authored
Merge pull request #597 from ztyyLV/Jackson-branch
Jackson branch
2 parents 6f2194f + c1134de commit d7bd4eb

File tree

1 file changed

+4
-165
lines changed

1 file changed

+4
-165
lines changed

info/api/WebTwain_Viewer.md

Lines changed: 4 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -426,16 +426,7 @@ Generate a independent ThumbnailViewer object.
426426

427427
**Syntax**
428428

429-
<div class="sample-code-prefix template2"></div>
430-
431-
>- 17.3+
432-
>- 17.2.5
433-
>
434429
```typescript
435-
/**
436-
*
437-
* @param thumbnailViewerSettings Configure the ThumbnailViewer object
438-
*/
439430
createThumbnailViewer(
440431
thumbnailViewerSettings?: ThumbnailViewerSettings
441432
): ThumbnailViewer;
@@ -635,165 +626,13 @@ interface ViewMode {
635626
scrollDirection?: string;
636627
}
637628
```
638-
```typescript
639-
/**
640-
 * Generate a independent ThumbnailViewer object.
641-
 * @param thumbnailViewerSettings Configure the ThumbnailViewer object
642-
*/
643-
createThumbnailViewer(
644-
thumbnailViewerSettings?: thumbnailViewerSettings
645-
): ThumbnailViewer;
646-
interface ThumbnailViewer {
647-
/**
648-
* Show the ThumbnailViewer object.
649-
*/
650-
show(): boolean;
651-
/**
652-
* Hide the ThumbnailViewer object.
653-
*/
654-
hide(): boolean;
655-
/**
656-
* Remove the ThumbnailViewer object.
657-
*/
658-
dispose(): boolean;
659-
/**
660-
* Change the view mode of the thumbnail viewer.
661-
* @param viewMode Specify the new mode.
662-
*/
663-
updateViewMode(viewMode: ViewMode): void;
664-
/**
665-
* Bind a listner to the specified event. You can bind one or multiple listeners to the same event.
666-
* @param eventName Specify the event name.
667-
* @param callback Specify the listner.
668-
*/
669-
on(eventName: string, callback: (event: ThumbnailViewerEvent | KeyboardEvent, domEvent?: MouseEvent) => void): void;
670-
/**
671-
* Unbind event listener(s) from the specified viewer event.
672-
* @param eventName Specify the event.
673-
* @param callback Specify the listener to remove
674-
*/
675-
off(eventName: string, callback?: () => void): void;
676-
/**
677-
* Whether to allow keyboard control. Default: true.
678-
*/
679-
allowKeyboardControl: boolean;
680-
/**
681-
* Whether to allow page dragging to reorder the pages.
682-
* Default: true.
683-
*/
684-
allowPageDragging: boolean;
685-
/**
686-
* Whether to allow resizing of the thumbnail viewer.
687-
* Default: false.
688-
*/
689-
allowResizing: boolean;
690-
/**
691-
* Set or return the CSS rule for the background of the thumbnail viewer.
692-
* Default: "rgb(255, 255, 255)".
693-
*/
694-
background: string;
695-
/**
696-
* Set or return the CSS rule for the border of the thumbnail viewer.
697-
* Default: "".
698-
*/
699-
border: string;
700-
/**
701-
* Set or return the CSS rule for the background of the page the mouse hovers over in the thumbnail viewer.
702-
* Default: "rgb(239, 246, 253)".
703-
*/
704-
hoverPageBackground: string;
705-
/**
706-
* Set or return the CSS rule for the border of the page the mouse hovers over in the thumbnail viewer.
707-
* Default: "1px solid rgb(238, 238, 238)".
708-
*/
709-
hoverPageBorder: string;
710-
/**
711-
* Set or return the location of the thumbnail viewer. Allowed values are "left", "right", "top", "bottom".
712-
* Default: "left".
713-
*/
714-
location: string;
715-
/**
716-
* Set or return the CSS rule for the background of a normal page in the thumbnail viewer.
717-
* Default: "transparent".
718-
*/
719-
pageBackground: string;
720-
/**
721-
* Set or return the CSS rule for the border of a normal page in the thumbnail viewer.
722-
* Default: "1px solid rgb(238, 238, 238)".
723-
*/
724-
pageBorder: string;
725-
/**
726-
* 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.
727-
* Default: 10.
728-
*/
729-
pageMargin: number | string;
730-
/**
731-
* 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.
732-
* Default: "rgb(251, 236, 136)".
733-
*/
734-
placeholderBackground: string;
735-
/**
736-
* Set or return whether the pages are arranged vertically or horizontally.
737-
* Default: "vertical". Allowed values are "vertical" and "horizontal".
738-
*/
739-
scrollDirection: string;
740-
/**
741-
* Set or return the CSS rule for the background of the selected page(s) in the thumbnail viewer.
742-
* Default: "rgb(199, 222, 252)".
743-
*/
744-
selectedPageBackground: string;
745-
/**
746-
* Set or return the CSS rule for the border of the selected page(s) in the thumbnail viewer.
747-
* Default: "1px solid rgb(125,162,206)".
748-
*/
749-
selectedPageBorder: string;
750-
/**
751-
* Set or return whether page numbers are shown.
752-
* Default: false.
753-
*/
754-
showPageNumber: boolean;
755-
/**
756-
* 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).
757-
* Default: "30%".
758-
*/
759-
size: number | string;
760-
/**
761-
* Set whether to select the index in the upper left corner of the viewer when scrolling.
762-
* Default: false.
763-
*/
764-
autoChangeIndex: boolean;
765-
/**
766-
* Show checkbox on image(s).
767-
*/
768-
showCheckbox: boolean;
769-
};
770-
interface ThumbnailViewerEvent {
771-
// The index of the current page.
772-
index: number;
773-
// The x-coordinate of the browser page.
774-
pageX: number;
775-
// The y-coordinate of the browser page.
776-
pageY: number;
777-
};
778-
interface ViewMode {
779-
/**
780-
* Specify the number of images per row.
781-
*/
782-
columns: number;
783-
/**
784-
* Specify the number of images per column.
785-
*/
786-
rows: number;
787-
/**
788-
* Set or return whether the pages are arranged vertically or horizontally.
789-
* Default: "vertical". Allowed values are "vertical" and "horizontal".
790-
*/
791-
scrollDirection: string;
792-
}
793-
```
794629

630+
**Parameters**
631+
632+
`thumbnailViewerSettings`: Configure the ThumbnailViewer object
795633

796634
**Availability**
635+
797636
<div class="availability">
798637
<table>
799638

0 commit comments

Comments
 (0)