Skip to content

Commit 35a2bb9

Browse files
update to internal commit 00667657
1 parent 760748c commit 35a2bb9

14 files changed

+188
-13
lines changed

_data/product_version.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
useGroupedVersion: true
22

33
version_info_list:
4-
- value: latest version (3.0)
4+
- value: latest version (3.1)
55
- value: 2.1
66
- value: 1.1
77

_includes/sidelist-apis.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,11 @@
150150
<li><a href="{{ site.api }}interface/searchtextoptions.html" class="otherLinkColour">SearchTextOptions</a></li>
151151
<li><a href="{{ site.api }}interface/updatedsource.html" class="otherLinkColour">UpdatedSource</a></li>
152152
<li><a href="{{ site.api }}interface/updatedpdfsource.html" class="otherLinkColour">UpdatedPdfSource</a></li>
153+
<li><a href="{{ site.api }}interface/ipagedata.html" class="otherLinkColour">IPageData</a></li>
153154
<li><a href="{{ site.api }}interface/ipointerevent.html" class="otherLinkColour">IPointerEvent</a></li>
154155
<li><a href="{{ site.api }}interface/iquadmodifiedevent.html" class="otherLinkColour">IQuadmodifiedEvent</a></li>
155-
<li><a href="{{ site.api }}interface/ipagedata.html" class="otherLinkColour">IPageData</a></li>
156+
<li><a href="{{ site.api }}interface/iundoredostatechangedevent.html" class="otherLinkColour">IUndoRedoStateChangedEvent</a></li>
157+
<li><a href="{{ site.api }}interface/ipaginationchangedevent.html" class="otherLinkColour">IPaginationChangedEvent</a></li>
156158
</ul>
157159
</li>
158160
<li><a class="otherLinkColour">Enumerations & Types</a>

api/class/browseviewer.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,14 @@ Browse Viewer is used to display pages in multiple-mode, pages can be multiple s
8787
| [`currentIndexChanged`](#currentindexchanged) |
8888
| [`currentPageChanged`](#currentpagechanged) |
8989
| [`selectedPagesChanged`](#selectedpageschanged) |
90+
| [`scroll`](#scroll) |
9091
| [`pagesDragged`](#pagesdragged) |
9192
| [`pagesDropped`](#pagesdropped) |
9293
| [`click`](#click) |
9394
| [`dblclick`](#dbclick) |
9495
| [`rightclick`](#rightclick) |
9596
| [`visibilityChanged`](#visibilitychanged) |
97+
| [`paginationChanged`](#paginationchanged) |
9698
| [`pointerdown`](#pointerdown) |
9799
| [`pointermove`](#pointermove) |
98100
| [`pointerup`](#pointerup) |
@@ -113,7 +115,7 @@ new Dynamsoft.DDV.BrowseViewer(options?: BrowseViewerConstructorOptions);
113115

114116
**Parameters**
115117

116-
`options`: The constructor options for a `BrowseViewer` instance. Please refer to [`BrowseViewerConstructorOptions`]({{ site.api }}interface/browseviewerconstructoroptions.html).
118+
`options`: The constructor options for a `BrowseViewer` instance. Please refer to [`BrowseViewerConstructorOptions`](/api/interface/browseviewerconstructoroptions.md).
117119

118120
**Code Snippet**
119121

@@ -1142,7 +1144,7 @@ Triggered when current page is changed.
11421144

11431145
#### selectedPagesChanged
11441146

1145-
Trigeered when the page(s) is selected.
1147+
Triggered when the page(s) is selected.
11461148

11471149
***Callback***
11481150

@@ -1158,6 +1160,10 @@ Trigeered when the page(s) is selected.
11581160

11591161
`newPageUids[]`: The array of new selected pages uids.
11601162

1163+
#### scroll
1164+
1165+
Triggered when the viewer is scrolled. It will return the native event object.
1166+
11611167
#### pagesDragged
11621168

11631169
Triggered when page(s) is dragged.
@@ -1193,6 +1199,10 @@ Triggered when page(s) is dropped.
11931199

11941200
Triggered when the viewer's visibility is changed. It will return an `isVisible` boolean value.
11951201

1202+
#### paginationChanged
1203+
1204+
Triggered when the viewer's current page number or the page count is changed. It will return an [`IPaginationChangedEvent`](/api/interface/ipaginationchangedevent.md) object.
1205+
11961206
#### pointerdown
11971207

11981208
Triggered when a pointer becomes active buttons state. It will return an [`IPointerEvent`](/api/interface/ipointerevent.md) object.

api/class/captureviewer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Capture Viewer is used to control camera, play video stream, and capture the ima
8585
| [`dblclick`](#dblclick) |
8686
| [`rightclick`](#rightclick) |
8787
| [`visibilityChanged`](#visibilitychanged) |
88+
| [`paginationChanged`](#paginationchanged) |
8889

8990
## Create and Destroy Instances
9091

@@ -1050,6 +1051,10 @@ Triggered when the used camera is changed.
10501051

10511052
`newDeviceId`: The new camera device id.
10521053

1054+
#### paginationChanged
1055+
1056+
Triggered when the viewer's current page number or the page count is changed. It will return an [`IPaginationChangedEvent`](/api/interface/ipaginationchangedevent.md) object.
1057+
10531058
#### visibilityChanged
10541059

10551060
Triggered when the viewer's visibility is changed. It will return an `isVisible` boolean value.

api/class/editviewer.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ Edit Viewer is used to edit the pages in document, such as, rotating, cropping,
7373
| [`setAnnotationDrawingStyle()`](#setannotationdrawingstyle) | Set the default drawing style of annotations by annotation type. |
7474
| [`selectAnnotations()`](#selectannotations) | Select the specified annotation(s) on the current page. |
7575
| [`getSelectedAnnotations()`](#getselectedannotations) | Get selected annotation(s). |
76+
| [`getAnnotationDrawingStyle()`](#getannotationdrawingstyle) | Get the annotation drawing style(s). |
77+
7678

7779
**Edit Operations**
7880

@@ -82,6 +84,7 @@ Edit Viewer is used to edit the pages in document, such as, rotating, cropping,
8284
| [`crop()`](#crop) | Crop the specified page(s) with the specified rectangle. |
8385
| [`getCropRect()`](#getcroprect) | Get the crop rectangular selection. |
8486
| [`setCropRect()`](#setcroprect) | Set a crop rectangular selection on the current page. *This method is only available when [`toolMode`](#toolmode) is `crop` mode.* |
87+
| [`cropMode`](#cropmode) | Get the current mode for cropping: crop the current image or all the images |
8588
| [`undo()`](#undo) | Undo the last editing operation. |
8689
| [`redo()`](#redo) | Redo the last undo operation. |
8790
| [`saveOperations()`](#saveoperations) | Save the edit operations in pages to document. |
@@ -122,19 +125,24 @@ Edit Viewer is used to edit the pages in document, such as, rotating, cropping,
122125
| [`cropRectDrawn`](#croprectdrawn) |
123126
| [`cropRectDeleted`](#croprectdeleted) |
124127
| [`cropRectModified`](#croprectmodified) |
128+
| [`annotationDrawingStyleChanged`](#annotationdrawingstylechanged) |
125129
| [`selectedAnnotationsChanged`](#selectedannotationschanged) |
126130
| [`click`](#click) |
127131
| [`dblclick`](#dbclick) |
128132
| [`rightclick`](#rightclick) |
129133
| [`visibilityChanged`](#visibilitychanged) |
130134
| [`textUnselected`](#textunselected) |
131135
| [`textSelected`](#textselected) |
132-
| [`textSearchTriggered`](#textSearchtriggered) |
136+
| [`textSearchTriggered`](#textsearchtriggered) |
137+
| [`undoRedoStateChanged`](#undoredostatechanged) |
138+
| [`paginationChanged`](#paginationchanged) |
139+
| [`pointerdown`](#pointerdown) |
133140
| [`pointerdown`](#pointerdown) |
134141
| [`pointermove`](#pointermove) |
135142
| [`pointerup`](#pointerup) |
136143
| [`pageover`](#pageover) |
137144
| [`pageout`](#pageout) |
145+
| [`scroll`](#scroll) |
138146

139147
## Create and Destroy Instances
140148

@@ -150,7 +158,7 @@ new Dynamsoft.DDV.EditViewer(options?: EditViewerConstructorOptions);
150158

151159
**Parameters**
152160

153-
`options`: The constructor options for an `EditViewer` instance. Please refer to [`EditViewerConstructorOptions`]({{ site.api }}interface/editviewerconstructoroptions.html).
161+
`options`: The constructor options for an `EditViewer` instance. Please refer to [`EditViewerConstructorOptions`](/api/interface/editviewerconstructoroptions.md).
154162

155163
**Code Snippet**
156164

@@ -943,6 +951,21 @@ const selectAnnots = editViewer.getSelectAnnotations();
943951
-80304 | No document opened. | `[]`
944952
-80305 | There is no image in the current document. | `[]`
945953

954+
### getAnnotationDrawingStyle()
955+
956+
Get the annotation drawing style.
957+
958+
**Syntax**
959+
960+
```typescript
961+
getAnnotationDrawingStyle(): AnnotationDrawingStyleConfig;
962+
```
963+
964+
**Return value**
965+
966+
An [`AnnotationDrawingStyleConfig`](/api/interface/styleinterface/annotationdrawingstyleconfig.md) object.
967+
968+
946969
## Display Control
947970

948971
### displayMode
@@ -1200,7 +1223,7 @@ crop(
12001223

12011224
`rect`: Specify the rectangle. Please refer to [`Rect`]({{ site.api }}interface/rect.html).
12021225

1203-
`indices`: Specify the indices of the pages to be cropped. If not set, the current page will be cropped.
1226+
`indices`: Specify the indices of the pages to be cropped. If not set, it will crop based on [`cropMode`](#cropmode), which uses the current image if the mode is `current` and all the images if the mode is `all`.
12041227

12051228
**Return Value**
12061229

@@ -1235,6 +1258,23 @@ editViewer.crop(rect, [0]); // Crop the first page
12351258

12361259
If one of the points of the rectangle is out of page range, crop operation does not take effect in this page and report warning.
12371260

1261+
1262+
### cropMode
1263+
1264+
Get or set the current mode for cropping: crop the current image or all the images.
1265+
1266+
**Syntax**
1267+
1268+
```typescript
1269+
cropMode: CropMode;
1270+
```
1271+
1272+
It can be one of the two types.
1273+
1274+
```typescript
1275+
type CropMode = "current" | "all";
1276+
```
1277+
12381278
### getCropRect()
12391279

12401280
Get the crop rectangular selection.
@@ -1739,6 +1779,10 @@ Triggered when the crop rectangular selection is modified.
17391779

17401780
`newRect`: The new rectangle.
17411781

1782+
#### annotationDrawingStyleChanged
1783+
1784+
Triggered when the annotation drawing style is changed. It will return the old drawing style and the new drawing style of the selected annotation. See also [`AnnotationDrawingStyleConfig`](/api/interface/styleinterface/annotationdrawingstyleconfig.md).
1785+
17421786
#### selectedAnnotationsChanged
17431787

17441788
Triggered when selected annotation(s) is changed.
@@ -1769,6 +1813,16 @@ Triggered when text is unselected.
17691813

17701814
Triggered when text search is performed. It will return an array of [`ITextSearchedInfo`](/api/interface/itextsearchedinfo.md).
17711815

1816+
1817+
1818+
#### undoRedoStateChanged
1819+
1820+
Triggered when the viewer's undo and redo state is changed. It will return an [`IUndoRedoStateChangedEvent`](/api/interface/iundoredostatechangedevent.md) object.
1821+
1822+
#### paginationChanged
1823+
1824+
Triggered when the viewer's current page number or the page count is changed. It will return an [`IPaginationChangedEvent`](/api/interface/ipaginationchangedevent.md) object.
1825+
17721826
#### pointerdown
17731827

17741828
Triggered when a pointer becomes active buttons state. It will return an [`IPointerEvent`](/api/interface/ipointerevent.md) object.
@@ -1789,6 +1843,10 @@ Triggered when a pointer is moved into a page's hit test boundaries. It will ret
17891843

17901844
Triggered when a pointer is moved out of the hit test boundaries of a page. It will return an [`IPointerEvent`](/api/interface/ipointerevent.md) object.
17911845

1846+
#### scroll
1847+
1848+
Triggered when the viewer is scrolled. It will return the native event object.
1849+
17921850
#### Mouse Events
17931851

17941852
##### click

api/class/perspectiveviewer.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Perspective Viewer is used to do page boundaries manual adjustment & perspective
8989
| [`dblclick`](#dbclick) |
9090
| [`rightclick`](#rightclick) |
9191
| [`visibilityChanged`](#visibilitychanged) |
92+
| [`paginationChanged`](#paginationchanged) |
9293
| [`pointerdown`](#pointerdown) |
9394
| [`pointermove`](#pointermove) |
9495
| [`pointerup`](#pointerup) |
@@ -1083,6 +1084,9 @@ Triggered when current page is changed.
10831084

10841085
Triggered when the quadrilateral selection is modified. Please refer to [`IQuadModifiedEvent`](/api/interface/iquadmodifiedevent.md).
10851086

1087+
#### paginationChanged
1088+
1089+
Triggered when the viewer's current page number or the page count is changed. It will return an [`IPaginationChangedEvent`](/api/interface/ipaginationchangedevent.md) object.
10861090

10871091
#### visibilityChanged
10881092

api/interface/browseviewerconfig.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ interface BrowseViewerConfig {
3030
scrollToLatest?: boolean;
3131
enableDragPage?: boolean;
3232
enableLoadSourceByDrag?: boolean;
33+
enableAutoScrollForDragPages?: boolean;
3334
scrollDirection?: string;
3435
}
3536
```
@@ -100,6 +101,13 @@ Enables loading files by dragging them into the Viewer.
100101

101102
Default value: `true`
102103

104+
### enableAutoScrollForDragPages
105+
106+
Specify whether to enable auto scrolling when dragging pages if the cursor is around the edges of the viewer.
107+
108+
Default value: `true`
109+
110+
103111
### scrollDirection
104112

105113
Specify the scroll direction, supported values are `vertical`, `horizontal`.

api/interface/browseviewerconstructoroptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ interface BrowseViewerConstructorOptions {
2020
keyboardInteractionConfig?: KeyboardInteractionConfig;
2121
viewerConfig?: BrowseViewerConfig;
2222
uiConfig?: UiConfig;
23-
groupUid?: string;
23+
groupUid?: string;
2424
}
2525
```
2626

@@ -36,7 +36,7 @@ This configures the use of keyboard shortcuts for the viewer - please see [`Keyb
3636

3737
### viewerConfig
3838

39-
The configurations of viewer, please refer to [`BrowseViewerConfig`]({{ site.api }}interface/browseviewerconfig.html). If it is not specified, the [default configuration]({{ site.viewer }}viewerconfig.html#browseviewerconfig) will be applied.
39+
The configurations of viewer, please refer to [`BrowseViewerConfig`](/api/interface/browseviewerconfig.md). If it is not specified, the [default configuration]({{ site.viewer }}viewerconfig.html#browseviewerconfig) will be applied.
4040

4141
### uiConfig
4242

api/interface/editviewerconfig.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ interface EditViewerConfig {
2222
quadSelectionStyle?: QuadSelectionStyle;
2323
enableLoadSourceByDrag?: boolean;
2424
enableMagnifier?: boolean;
25-
enableSlide?: boolean;
25+
enableSlide?: boolean;
26+
enableAutoScrollForTextSelection?: boolean;
2627
scrollToLatest?: boolean;
2728
scrollDirection?: string;
2829
minZoom?: number;
@@ -56,7 +57,7 @@ Default value: `true`
5657

5758
### enableMagnifier
5859

59-
Specifies whether or not to display a corner magnifier on the canvas. This feature is primarily used to provide a zoomed-in preview of the selected area for more precise adjustments.
60+
Specify whether or not to display a corner magnifier on the canvas. This feature is primarily used to provide a zoomed-in preview of the selected area for more precise adjustments.
6061

6162
Default value: `true`
6263

@@ -66,6 +67,12 @@ Specify whether allow to slide the pages.
6667

6768
Default value: `true`
6869

70+
### enableAutoScrollForTextSelection
71+
72+
Specify whether to enable auto scrolling when selecting text if the cursor is around the edges of the viewer.
73+
74+
Default value: `true`
75+
6976
### scrollToLatest
7077

7178
Specify whether to scroll to latest page automatically when importing new pages.

api/interface/editviewerconstructoroptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The container which is used to show the viewer. Its `id` or `HTMLElement` is acc
3434

3535
### viewerConfig
3636

37-
The configurations of viewer, please refer to [`EditViewerConfig`]({{ site.api }}interface/editviewerconfig.html). If it is not specified, the [default configuration]({{ site.viewer }}viewerconfig.html#editviewerconfig) will be applied.
37+
The configurations of viewer, please refer to [`EditViewerConfig`](/api/interface/editviewerconfig.md). If it is not specified, the [default configuration]({{ site.viewer }}viewerconfig.html#editviewerconfig) will be applied.
3838

3939
### uiConfig
4040

0 commit comments

Comments
 (0)