Merge pull request #267 from dynamsoft-docs/preview

4.0

Author: tony-xlh

_config.yml

@@ -44,6 +44,9 @@ collections:
   v2.1:
     output: true
     permalink: /:path-:collection:output_ext
+  v3.2.1:
+    output: true
+    permalink: /:path-:collection:output_ext
 
 defaults:
   - scope:

_data/full_tree.yml

@@ -12,4 +12,5 @@ tree_file_list:
   - sidelist-apis-v1.0.0.html
   - sidelist-apis-v1.1.html
   - sidelist-apis-v2.1.html
+  - sidelist-apis-v3.2.1.html
 

_data/product_version.yml

@@ -1,7 +1,8 @@
 useGroupedVersion: true
 
 version_info_list:
-  - value: latest version (3.2.1)
+  - value: latest version (4.0)
+  - value: 3.2.1
   - value: 2.1
   - value: 1.1
 

_includes/sidelist-apis-v3.2.1.html

@@ -29,6 +29,7 @@
                 <li><a href="{{ site.api }}class/annotation/index.html" class="otherLinkColour">Annotation</a>
                     <ul>   
                         <li><a href="{{ site.api }}class/annotation/rectangle.html" class="otherLinkColour">Rectangle</a></li>
+                        <li><a href="{{ site.api }}class/annotation/redaction.html" class="otherLinkColour">Redaction</a></li>
                         <li><a href="{{ site.api }}class/annotation/ellipse.html" class="otherLinkColour">Ellipse</a></li>
                         <li><a href="{{ site.api }}class/annotation/polygon.html" class="otherLinkColour">Polygon</a></li>
                         <li><a href="{{ site.api }}class/annotation/polyline.html" class="otherLinkColour">Polyline</a></li>
@@ -75,6 +76,7 @@
                 <li><a href="{{ site.api }}interface/annotationinterface/index.html" class="otherLinkColour">Annotation Interfaces</a>
                     <ul>
                         <li><a href="{{ site.api }}interface/annotationinterface/rectannotationoptions.html" class="otherLinkColour">RectAnnotationOptions</a></li>
+                        <li><a href="{{ site.api }}interface/annotationinterface/redactionannotationoptions.html" class="otherLinkColour">RedactionAnnotationOptions</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/ellipseannotationoptions.html" class="otherLinkColour">EllipseAnnotationOptions</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/polygonannotationoptions.html" class="otherLinkColour">PolygonAnnotationOptions</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/polylineannotationoptions.html" class="otherLinkColour">PolylineAnnotationOptions</a></li>
@@ -90,6 +92,7 @@
                         <li><a href="{{ site.api }}interface/annotationinterface/point.html" class="otherLinkColour">Point</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/textcontent.html" class="otherLinkColour">TextContent</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/rectanglestyle.html" class="otherLinkColour">RectangleStyle</a></li>
+                        <li><a href="{{ site.api }}interface/annotationinterface/redactionstyle.html" class="otherLinkColour">RedactionStyle</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/ellipsestyle.html" class="otherLinkColour">EllipseStyle</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/polygonstyle.html" class="otherLinkColour">PolygonStyle</a></li>
                         <li><a href="{{ site.api }}interface/annotationinterface/polylinestyle.html" class="otherLinkColour">PolylineStyle</a></li>

_includes/sidelist-apis.html

@@ -0,0 +1,209 @@
+---
+layout: default-layout
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+title: Dynamsoft Document Viewer API Reference - Ellipse Class
+keywords: Documentation, Dynamsoft Document Viewer, API Reference, Ellipse Class
+breadcrumbText: Ellipse Class
+description: Dynamsoft Document Viewer Documentation API Reference Ellipse Class Page
+
+---
+
+# Ellipse Class
+
+
+## API Index
+
+| API Name                                | Description                                                                                 |
+| --------------------------------------- | ------------------------------------------------------------------------------------------- |
+| [`uid`](#uid)                           | Return the uid of the annotation.                                                           |
+| [`pageUid`](#pageuid)                   | Return the uid of the page where the annotation is located.                                 |
+| [`source`](#source)                   | Return the source of the annotation.                               |
+| [`type`](#type)                   | Return the type of the annotation                               |
+| [`creationDate`](#creationdate)         | Return the creation date of the annotation.                                                 |
+| [`flattened`](#flattened)               | Flattens the annotation onto the image layer, or inspect if the annotation is flattened. |
+| [`modificationDate`](#modificationdate) | Return the modification date of the annotation.                                             |
+| [`getOptions()`](#getoptions)           | Get the annotation options.                                                                 |
+| [`updateOptions()`](#updateoptions)     | Update the annotation options.                                                              |
+
+## uid
+
+Return the uid of the annotation.
+
+**Syntax**
+
+```typescript
+readonly uid: string;
+```
+
+{% comment %}
+**Remark**
+
+- It will return `''`, if the annotation is deleted. 
+{% endcomment %}
+
+## pageUid
+
+Return the uid of the page where the annotation is located.
+
+**Syntax**
+
+```typescript
+readonly pageUid: string;
+```
+
+**Remark**
+
+- It will return `''`, if the annotation is deleted. 
+
+{% comment %}
+## aabb
+
+Return Axis-aligned bounding box of the annotation.
+
+**Syntax**
+
+```typescript
+readonly aabb: Rect;
+```
+
+**Remark**
+
+![AABB-Ellipse](/assets/imgs/aabbellipse.png)
+
+{% endcomment %}
+
+## source
+
+Return the source of the annotation. Possible values:
+
+* user: the annotation is created by the user's action
+* file: the annotation is created from a PDF file
+* api: the annotation is created with code
+
+**Remark**
+
+It will return `''`, if the annotation is deleted.
+
+## type
+
+Return the type of the annotation: `ellipse`.
+
+All annotation types:
+
+```ts
+"rectangle" | "ellipse" | "line" | "polygon" | "polyline" | "ink" | "textBox" | "textTypewriter" | "stamp" | "highlight" | "underline" | "strikeout" | "incomplete" | "unknown"
+```
+
+## creationDate
+
+Return the creation date of the annotation.
+
+**Syntax**
+
+```typescript
+readonly creationDate: string;
+```
+
+**Remark**
+
+- The string would be `D:YYYYMMDDHHmmSSOHH'mm'`, like `D:20230101085959-08'00'`.
+
+{% comment %}
+- It will return `''`, if the annotation is deleted. 
+{% endcomment %}
+
+## flattened
+
+Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
+
+**Syntax**
+
+```typescript
+flattened: boolean;   //Default value is `false`.
+```
+
+**Remark**
+
+Flattened annotations move below all unflattened annotations on the page, and are stacked amongst themselves accordingly.
+
+Flattened annotations become part of the page layer upon file export and cease to be annotations.
+
+## modificationDate
+
+Return the modification date of the annotation.
+
+**Syntax**
+
+```typescript
+readonly modificationDate: string;
+```
+
+**Remark**
+
+- The string would be `D:YYYYMMDDHHmmSSOHH'mm'`, like `D:20230101085959-08'00'`.
+- It will return `''`, if the annotation is deleted.
+- If the annotation is created but not be modified after adding, it equals to [`creationDate`](#creationdate). 
+
+## getOptions()
+
+Get the annotation options.
+
+**Syntax**
+
+```typescript
+getOptions(): EllipseAnnotationOptions;
+```
+
+**Return value**
+
+The object of ellipse annotation options. Please refer to [`EllipseAnnotationOptions`]({{ site.api }}interface/annotationinterface/ellipseannotationoptions.html).
+
+**Code Snippet**
+
+```typescript
+// Given that editViewer is an existing instance of EditViewer and a document is currently open.
+const pageUid = editViewer.indexToUid(0);
+const ellipse = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "ellipse"); // Create a default Ellipse annotation instance.
+const ellipseOptions = ellipse.getOptions();
+```
+
+## updateOptions() 
+
+Update the annotation options.
+
+**Syntax**
+
+```typescript
+updateOptions(ellipseAnnotationOptions: EllipseAnnotationOptions): boolean;
+```
+
+**Parameters**
+
+`ellipseAnnotationOptions`: The new ellipse annotation options. Please refer to [`EllipseAnnotationOptions`]({{ site.api }}interface/annotationinterface/ellipseannotationoptions.html).
+
+**Return value**
+
+`true`: Successfully.
+
+`false`: Failed.
+
+**Code Snippet**
+
+```typescript
+// Given that editViewer is an existing instance of EditViewer and a document is currently open.
+const pageUid = editViewer.indexToUid(0);
+const ellipse = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "ellipse"); // Create a default Ellipse annotation instance.
+const ellipseOptions = {
+    background: "red",
+};
+ellipse.updateOptions(ellipseOptions); // Update the background of the ellipse to red.
+```
+
+**Warning**
+
+ Error Code  | Error Message                                        | API Return Value
+--------|-----------------------------------------------------|----------------------
+ -80100 | *XXX(API)*: *XXX(ParameterName)* is invalid.   | `false`
+ -80102 | *XXX(API)*: *XXX(ParameterName)* is missing.  | `false`