update to internal commit 67dabc3c

DMGithubPublisher · DMGithubPublisher · commit 22616757a59b · 2024-05-30T03:04:05.000-07:00
diff --git a/_includes/api-reference/intermediate-result-unit-android.md b/_includes/api-reference/intermediate-result-unit-android.md
@@ -0,0 +1,12 @@
+
+
+| Method | Description |
+|------- |-------------|
+| [`getHashId`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Returns the hash ID of the unit. |
+| [`getOriginalImageHashId`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Returns the hash ID of the original image. |
+| [`getOriginalImageTag`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) | Returns the image tag of the original image. |
+| [`getType`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#gettype) | Returns the type of the intermediate result unit. |
+| [`getTransformMatrix`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) | Returns the transformation matrix via [`DSTransformMatrixType`]({{site.dcv_enumerations}}/core/transform-matrix-type.html). |
+| [`clone`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
+| [`replace`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html#replace) | Replaces the content of the intermediate result unit. |
+
diff --git a/_includes/api-reference/intermediate-result-unit-ios.md b/_includes/api-reference/intermediate-result-unit-ios.md
@@ -0,0 +1,12 @@
+
+
+| Method | Description |
+|------- |-------------|
+| [`getHashId`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Returns the hash ID of the unit. |
+| [`getOriginalImageHashId`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Returns the hash ID of the original image. |
+| [`getOriginalImageTag`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) | Returns the image tag of the original image. |
+| [`getType`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#gettype) | Returns the type of the intermediate result unit. |
+| [`getTransformMatrix`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) | Returns the transformation matrix via [`DSTransformMatrixType`]({{site.dcv_enumerations}}/core/transform-matrix-type.html). |
+| [`clone`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
+| [`replace`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#replace) | Replaces the content of the intermediate result unit. |
+
diff --git a/_includes/api-reference/region-object-element-android.md b/_includes/api-reference/region-object-element-android.md
@@ -0,0 +1,11 @@
+
+
+
+| Method | Description |
+|------- |-------------|
+| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
+| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. |
+| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
+| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |
+
+
diff --git a/_includes/api-reference/region-object-element-ios.md b/_includes/api-reference/region-object-element-ios.md
@@ -0,0 +1,11 @@
+
+
+
+| Method | Description |
+|------- |-------------|
+| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
+| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. |
+| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
+| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |
+
+
diff --git a/programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md b/programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md
@@ -22,7 +22,7 @@ The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose
 class CandidateQuadEdgesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
diff --git a/programming/android/api-reference/candidate-quad-edges-unit.md b/programming/android/api-reference/candidate-quad-edges-unit.md
@@ -22,7 +22,7 @@ The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose
 class CandidateQuadEdgesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
@@ -34,6 +34,10 @@ class CandidateQuadEdgesUnit extends IntermediateResultUnit
 | [`addCandidateQuadEdge`](#addcandidatequadedge) | Add an edge. |
 | [`setCandidateQuadEdge`](#setcandidatequadedge) | Set an edge. |
 
+The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-android.md -%}
+
 ### getCandidateQuadEdges
 
 Get an array of edges. It includes all edges that candidate quadrilaterals assembling.
diff --git a/programming/android/api-reference/corners-unit-v2.0.20.md b/programming/android/api-reference/corners-unit-v2.0.20.md
@@ -22,7 +22,7 @@ The `CornersUnit` class represents an intermediate result unit whose type is cor
 class CornersUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
diff --git a/programming/android/api-reference/corners-unit.md b/programming/android/api-reference/corners-unit.md
@@ -22,7 +22,7 @@ The `CornersUnit` class represents an intermediate result unit whose type is cor
 class CornersUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
@@ -34,6 +34,10 @@ class CornersUnit extends IntermediateResultUnit
 | [`addCorner`](#addcorner) | Add a corner. |
 | [`setCorner`](#setcorner) | Set a corner. |
 
+The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-android.md -%}
+
 ### getCorners
 
 Get an array of corners. It includes all corners that participate quadrilaterals assembling.
diff --git a/programming/android/api-reference/detected-quad-element.md b/programming/android/api-reference/detected-quad-element.md
@@ -22,13 +22,17 @@ The `DetectedQuadElement` class represents a detected quadrilateral element, whi
 class DetectedQuadElement extends RegionObjectElement
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
 | [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
 
-## getConfidenceAsDocumentBoundary
+The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).
+
+{%- include api-reference/region-object-element-android.md -%}
+
+### getConfidenceAsDocumentBoundary
 
 Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
 
diff --git a/programming/android/api-reference/detected-quad-result-item.md b/programming/android/api-reference/detected-quad-result-item.md
@@ -22,13 +22,22 @@ The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]
 class DetectedQuadResultItem extends CapturedResultItem
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ------- | ----------- |
 | [`getLocation`](#getlocation) | Get a Quadrilateral object as the location of current object. |
 | [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
 
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
+
+| Method | Description |
+| ------ | ----------- |
+| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
+| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
+| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
+| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
+
 ### getLocation
 
 Returns a [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
diff --git a/programming/android/api-reference/detected-quads-result.md b/programming/android/api-reference/detected-quads-result.md
@@ -22,7 +22,7 @@ The `DetectedQuadsResult` class represents a collection of [`DetectedQuadResultI
 class DetectedQuadsResult
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
diff --git a/programming/android/api-reference/detected-quads-unit-v2.0.20.md b/programming/android/api-reference/detected-quads-unit-v2.0.20.md
@@ -22,7 +22,7 @@ The `DetectedQuadsUnit` class represents an intermediate result unit whose type
 class DetectedQuadsUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
diff --git a/programming/android/api-reference/detected-quads-unit.md b/programming/android/api-reference/detected-quads-unit.md
@@ -22,18 +22,22 @@ The `DetectedQuadsUnit` class represents an intermediate result unit whose type
 class DetectedQuadsUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
 | [`getDetectedQuads`](#getdetectedquads) | Gets an array of `DetectedQuadElement` objects, each containing the information of a single detected quadrilateral. |
 | [`getCount`](#getcount) | Gets the number of detected quadrilaterals. |
 | [`getDetectedQuad`](#getdetectedquad) | Gets a detected quadrilateral. |
-| [`removeAllDetectedQuads`](#removedetectedquads) | Removes all detected quadrilaterals. |
+| [`removeAllDetectedQuads`](#removealldetectedquads) | Removes all detected quadrilaterals. |
 | [`removeDetectedQuad`](#removedetectedquad) | Removes a detected quadrilateral. |
 | [`addDetectedQuad`](#adddetectedquad) | Adds a detected quadrilateral. |
 | [`setDetectedQuad`](#setdetectedquad) | Sets a detected quadrilateral. |
 
+The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-android.md -%}
+
 ### getDetectedQuads
 
 Gets an array of `DetectedQuadElement` objects, each containing the information of a single detected quadrilateral.
diff --git a/programming/android/api-reference/long-lines-unit-v2.0.20.md b/programming/android/api-reference/long-lines-unit-v2.0.20.md
@@ -22,7 +22,7 @@ The `LongLinesUnit` class represents an intermediate result unit whose type is l
 class LongLinesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
diff --git a/programming/android/api-reference/long-lines-unit.md b/programming/android/api-reference/long-lines-unit.md
@@ -22,7 +22,7 @@ The `LongLinesUnit` class represents an intermediate result unit whose type is l
 class LongLinesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
@@ -34,6 +34,10 @@ class LongLinesUnit extends IntermediateResultUnit
 | [`addLongLine`](#addlongline) | Add a long line. |
 | [`setLongLine`](#setlongline) | Set a long line. |
 
+The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-android.md -%}
+
 ### getLongLines
 
 Get an array of [`LineSegment`]({{site.dcv_android_api}}core/basic-structures/line-segment.html) as the long lines.
diff --git a/programming/android/api-reference/normalized-image-element.md b/programming/android/api-reference/normalized-image-element.md
@@ -22,12 +22,16 @@ The `NormalizedImageElement` class represents an intermediate result whose type
 class NormalizedImageElement extends RegionObjectElement
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
 | [`getImageData`](#getimagedata) | Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the normalized image. |
 
+The following methods are inherited from class [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html).
+
+{%- include api-reference/region-object-element-android.md -%}
+
 ### getImageData
 
 Gets an [`ImageData`]({{site.dcv_android_api}}core/basic-structures/image-data.html) object as the normalized image.
diff --git a/programming/android/api-reference/normalized-image-result-item.md b/programming/android/api-reference/normalized-image-result-item.md
@@ -22,13 +22,22 @@ The `NormalizedImageResultItem` class is an extension of [`CapturedResultItem`](
 class NormalizedImageResultItem extends CapturedResultItem
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
 | [`getImageData`](#getimagedata) | Gets an `ImageData` object as the normalized image. |
 | [`getLocation`](#getlocation) | The quadrilateral from which you get the normalized image result item. |
 
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html).
+
+| Method | Description |
+| ------ | ----------- |
+| [`getType`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettype) | Get the type of the captured result item, indicating what kind of data it represents. |
+| [`getReferencedItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Get a property of type `CapturedResultItem` that represents a reference to another captured result item. |
+| [`getTargetROIDefName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
+| [`getTaskName`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html#gettaskname) | The name of the task that generated the result. |
+
 ### getImageData
 
 Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the normalized image.
diff --git a/programming/android/api-reference/normalized-image-unit-v2.0.20.md b/programming/android/api-reference/normalized-image-unit-v2.0.20.md
@@ -22,7 +22,7 @@ The `NormalizedImagesUnit` class represents an intermediate result unit whose ty
 class NormalizedImagesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
diff --git a/programming/android/api-reference/normalized-image-unit.md b/programming/android/api-reference/normalized-image-unit.md
@@ -22,7 +22,7 @@ The `NormalizedImagesUnit` class represents an intermediate result unit whose ty
 class NormalizedImagesUnit extends IntermediateResultUnit
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
@@ -32,6 +32,10 @@ class NormalizedImagesUnit extends IntermediateResultUnit
 | [`removeAllNormalizedImages`](#removeallnormalizedimages) | Removes all normalized images. |
 | [`setNormalizedImage`](#setnormalizedimage) | Sets a normalized image. |
 
+The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-android.md -%}
+
 ### getNormalizedImages
 
 Gets an array of [`NormalizedImageElement`](normalized-image-element.md).
diff --git a/programming/android/api-reference/normalized-images-result.md b/programming/android/api-reference/normalized-images-result.md
@@ -22,7 +22,7 @@ The `NormalizedImagesResult` class represents a collection of [`NormalizedImageR
 class NormalizedImagesResult
 ```
 
-## Methods Summary
+## Methods
 
 | Methods | Description |
 | ---------- | ----------- |
diff --git a/programming/ios/api-reference/candidate-quad-edges-unit.md b/programming/ios/api-reference/candidate-quad-edges-unit.md
@@ -41,6 +41,10 @@ class CandidateQuadEdgesUnit: IntermediateResultUnit
 | [`addCandidateQuadEdge`](#addcandidatequadedge) | Add an edge. |
 | [`setCandidateQuadEdge`](#setcandidatequadedge) | Set an edge. |
 
+The following methods are inherited from class [`DSIntermediateResultUnit`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-ios.md -%}
+
 ### getCandidateQuadEdges
 
 Get an array of edges. It includes all edges that candidate quadrilaterals assembling.
diff --git a/programming/ios/api-reference/corners-unit.md b/programming/ios/api-reference/corners-unit.md
@@ -41,6 +41,10 @@ class CornersUnit : IntermediateResultUnit
 | [`addCorner`](#addcorner) | Add a corner. |
 | [`setCorner`](#setcorner) | Set a corner. |
 
+The following methods are inherited from class [`DSIntermediateResultUnit`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html).
+
+{%- include api-reference/intermediate-result-unit-ios.md -%}
+
 ### getCorners
 
 Get an array of `DSCorner` that represent all the assembled corners. The corners will participate assembling.
diff --git a/programming/ios/api-reference/detected-quad-element-v2.0.20.md b/programming/ios/api-reference/detected-quad-element-v2.0.20.md
@@ -0,0 +1,53 @@
+---
+layout: default-layout
+title: DSDetectedQuadElement - Dynamsoft Document Normalizer module iOS Edition API Reference
+description: The class DSDetectedQuadElement of Dynamsoft Document Normalizer module represents a detected quadrilateral element, which is an intermediate result in the document scanning process.
+keywords: detected quad, objective-c, swift
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DSDetectedQuadElement
+
+The `DSDetectedQuadElement` class represents a detected quadrilateral element, which is an intermediate result in the document scanning process. It is a subclass of `DSRegionObjectElement`.
+
+## Definition
+
+*Assembly:* DynamsoftDocumentNormalizer.xcframework
+
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
+```objc
+@interface DSDetectedQuadElement: DSRegionObjectElement
+```
+2. 
+```swift
+class DetectedQuadElement: RegionObjectElement
+```
+
+## Attributes
+
+| Attributes | Type | Description |
+| ---------- | ---- | ----------- |
+| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *NSInteger* | The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
+
+## confidenceAsDocumentBoundary
+
+The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
+
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
+```objc
+@property(nonatomic, assign, readonly) NSInteger confidenceAsDocumentBoundary;
+```
+2. 
+```swift
+var confidenceAsDocumentBoundary: Int { get }
+```
diff --git a/programming/ios/api-reference/detected-quad-element.md b/programming/ios/api-reference/detected-quad-element.md
diff --git a/programming/ios/api-reference/detected-quad-result-item.md b/programming/ios/api-reference/detected-quad-result-item.md
diff --git a/programming/ios/api-reference/detected-quads-unit.md b/programming/ios/api-reference/detected-quads-unit.md
diff --git a/programming/ios/api-reference/long-lines-unit.md b/programming/ios/api-reference/long-lines-unit.md
diff --git a/programming/ios/api-reference/normalized-image-element-v2.0.20.md b/programming/ios/api-reference/normalized-image-element-v2.0.20.md
diff --git a/programming/ios/api-reference/normalized-image-element.md b/programming/ios/api-reference/normalized-image-element.md
diff --git a/programming/ios/api-reference/normalized-image-result-item.md b/programming/ios/api-reference/normalized-image-result-item.md
diff --git a/programming/ios/api-reference/normalized-image-unit.md b/programming/ios/api-reference/normalized-image-unit.md
