Skip to content

Commit 366300e

Browse files
Ellie-dynamsoftEllie-dynamsoft
authored
Merge pull request #247 from dynamsoft-docs/preview
Preview
2 parents e182d08 + e6d4603 commit 366300e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1501
-325
lines changed

‎_data/product_version.yml

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

33
version_info_list:
4-
- value: latest version(2.0)
4+
- value: latest version(2.1)
5+
- value: 2.0
56
- value: 1.x
67
child:
78
- 1.1

‎_includes/sidelist-apis.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
<li><a href="{{ site.api }}interface/styleinterface/pagenumberstyle.html" class="otherLinkColour">PageNumberStyle</a></li>
6969
<li><a href="{{ site.api }}interface/styleinterface/quadselectionstyle.html" class="otherLinkColour">QuadSelectionStyle</a></li>
7070
<li><a href="{{ site.api }}interface/styleinterface/annotationselectionstyle.html" class="otherLinkColour">AnnotationSelectionStyle</a></li>
71+
<li><a href="{{ site.api }}interface/styleinterface/annotationdrawingstyleconfig.html" class="otherLinkColour">AnnotationDrawingStyleConfig</a></li>
7172
</ul>
7273
</li>
7374
<li><a class="otherLinkColour">Annotation Interfaces</a>
@@ -99,6 +100,7 @@
99100
</ul>
100101
</li>
101102
<li><a href="{{ site.api }}interface/configresult.html" class="otherLinkColour">ConfigResult</a></li>
103+
<li><a href="{{ site.api }}interface/keyboardinteractionconfig.html" class="otherLinkColour">KeyboardInteractionConfig</a></li>
102104
<li><a href="{{ site.api }}interface/createdocumentoptions.html" class="otherLinkColour">CreateDocumentOptions</a></li>
103105
<li><a href="{{ site.api }}interface/mergedocumentoptions.html" class="otherLinkColour">MergeDocumentOptions</a></li>
104106
<li><a href="{{ site.api }}interface/transferoptions.html" class="otherLinkColour">TransferOptions</a></li>
@@ -127,6 +129,7 @@
127129
<li><a href="{{ site.api }}interface/vimagedata.html" class="otherLinkColour">VImageData</a></li>
128130
<li><a href="{{ site.api }}interface/iimagefilter.html" class="otherLinkColour">IImageFilter</a></li>
129131
<li><a href="{{ site.api }}interface/imagefilteritem.html" class="otherLinkColour">ImageFilterItem</a></li>
132+
<li><a href="{{ site.api }}interface/infoobject.html" class="otherLinkColour">InfoObject</a></li>
130133
<li><a href="{{ site.api }}interface/idocumentdetect.html" class="otherLinkColour">IDocumentDetect</a></li>
131134
<li><a href="{{ site.api }}interface/detectresult.html" class="otherLinkColour">DetectResult</a></li>
132135
<li><a href="{{ site.api }}interface/documentdetectconfig.html" class="otherLinkColour">DocumentDetectConfig</a></li>

‎api/class/annotation/ellipse.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ permalink: /api/class/annotation/ellipse.html
1515

1616
## API Index
1717

18-
| API Name | Description |
19-
| ---------------------- | ----------------------------------------------------------- |
20-
| [`uid`](#uid) | Return the uid of the annotation. |
21-
| [`pageUid`](#pageuid) | Return the uid of the page where the annotation is located. |
22-
| [`creationDate`](#creationdate) | Return the creation date of the annotation. |
23-
| [`modificationDate`](#modificationdate) | Return the modification date of the annotation. |
24-
| [`getOptions()`](#getoptions) | Get the annotation options. |
25-
| [`updateOptions()`](#updateoptions) | Update the annotation options. |
18+
| API Name | Description |
19+
| --------------------------------------- | ------------------------------------------------------------------------------------------- |
20+
| [`uid`](#uid) | Return the uid of the annotation. |
21+
| [`pageUid`](#pageuid) | Return the uid of the page where the annotation is located. |
22+
| [`creationDate`](#creationdate) | Return the creation date of the annotation. |
23+
| [`flattened`](#flattened) | Flattens the annotation onto the image layer, or inspect if the annotation is flattened. |
24+
| [`modificationDate`](#modificationdate) | Return the modification date of the annotation. |
25+
| [`getOptions()`](#getoptions) | Get the annotation options. |
26+
| [`updateOptions()`](#updateoptions) | Update the annotation options. |
2627

2728
## uid
2829

@@ -89,6 +90,22 @@ readonly creationDate: string;
8990
- It will return `''`, if the annotation is be deleted.
9091
{% endcomment %}
9192

93+
## flattened
94+
95+
Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
96+
97+
**Syntax**
98+
99+
```typescript
100+
flattened: boolean;
101+
```
102+
103+
**Remark**
104+
105+
Flattened annotations move below all unflattened annotations on the page, and are stacked amongst themselves accordingly.
106+
107+
Flattened annotations become part of the page layer upon file export and cease to be annotations.
108+
92109
## modificationDate
93110

94111
Return the modification date of the annotation.

‎api/class/annotation/incomplete.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ This type of annotation may not be supported by Dynamsoft Document Viewer so far
1616

1717
## API Index
1818

19-
| API Name | Description |
20-
| ---------------------- | ----------------------------------------------------------- |
21-
| [`uid`](#uid) | Return the uid of the annotation. |
22-
| [`pageUid`](#pageuid) | Return the uid of the page where the annotation is located. |
23-
| [`creationDate`](#creationdate) | Return the creation date of the annotation. |
24-
| [`raw`](#raw) | Return the raw data of the annotation. |
19+
| API Name | Description |
20+
| ------------------------------- | ----------------------------------------------------------- |
21+
| [`uid`](#uid) | Return the uid of the annotation. |
22+
| [`pageUid`](#pageuid) | Return the uid of the page where the annotation is located. |
23+
| [`creationDate`](#creationdate) | Return the creation date of the annotation. |
24+
| [`raw`](#raw) | Return the raw data of the annotation. |
2525

2626

2727
## uid

0 commit comments

Comments
 (0)